物联网边缘计算支持使用边缘端API管理接入到网关的设备,包括获取设备及设备列表、设置设备属性、订阅设备事件等。边缘端API的对外提供服务的端口号为9999,所有接口均支持HTTPS单向认证。

说明 该版本OpenAPI推荐在v2.1.1及以下版本的Link IoT Edge中使用,v2.1.1以上版本Link IoT Edge中推荐使用更高版本的OpenAPI。

调用方式

边缘端OpenAPI支持HTTP或者HTTPS请求,允许POST方法。

权限校验机制

边缘端OpenAPI采用Basic Authentication登录认证方式,开发者必须知道网关的用户名与密码,并且该用户名具备访问相应API的权限才能完成接口调用。
说明 网关的初始用户名为admin,密码为admin1234,可通过访问边缘网关控制台修改用户名密码和API访问权限。访问边缘网关控制台的操作请参考远程服务访问

API列表

  • 权限校验类

    需要先登录网关,通过认证获取cookie后,才能继续调用其他接口。

    API名称 API描述
    Login 用户登录认证接口。
    Logout 用户取消认证接口。
  • 设备管理类

    对设备属性/服务/事件的操作将会直接下发到设备上。

    API 名称 API 描述
    queryThingCount 获取网关子设备(设备接入网关后称为网关子设备)总数。支持按照设备在线状态进行过滤。
    getAuthedDeviceList 获取网关子设备列表。支持按照设备标签、设备在线状态过滤。
    setThingProperties 设置设备的属性。支持单次设置设备的多个属性。
    getThingProperties 获取设备的属性。支持单次获取设备的多个属性。
    invokeThingServices 调用设备服务。
    getThingsEventsInfo 订阅设备事件。支持订阅多个设备的多个事件。