外部应用可以通过边缘端HTTP API访问Link IoT Edge并获取设备信息、设置设备属性、调用函数计算等。
边缘端HTTP API对外提供服务的端口号为9999
。为保证传输安全,所有接口仅支持HTTPS协议。
认证授权
目前支持通过Cookie认证方式访问HTTP API。开发者必须通过CreateAuthCookie接口获取认证Cookie才能进一步调用其它API。具体步骤如下所示。
- 通过访问如下地址,登录边缘网关控制台,配置API访问权限。
https://{ip}:9999
其中,{ip}为网关所在机器的IP地址。
说明 登录边缘网关控制台的初始用户名为admin,密码为admin1234。建议您登录边缘网关控制台后,修改用户名和密码。 - 调用CreateAuthCookie接口创建认证Cookie。
CreateAuthCookie接口采用Basic Authentication认证方式,即通过HTTP请求头部
Authorization
字段传递认证标识。Authorization字段格式如下所示。
Authorization: Basic <base64(username:password)>
其中,base64(username:password)是<登录边缘网关控制台的用户名:密码>的Base64编码字符串。
例如,登录边缘网关控制台的用户名为admin,密码为admin1234,则
Authorization
字段内容如下所示。Authorization: Basic YWRtaW46YWRtaW4xMjM0
- 从CreateAuthCookie接口的HTTP响应头中,获取
Set-Cookie
参数的值。Set-Cookie
字段格式如下所示。Set-Cookie: token=d71020ad5cb58faf04a6fd81d6df9680582b987eb6d0ce7b33bc3a3e4f******; Max-Age=3600; Path=/
- 将CreateAuthCookie接口响应头的
Set-Cookie
参数值,当做其它API HTTP请求头的Cookie
参数值。HTTP请求头的Cookie
参数格式如下所示。Cookie: token=d71020ad5cb58faf04a6fd81d6df9680582b987eb6d0ce7b33bc3a3e4f******; Max-Age=3600; Path=/
- 调用除CreateAuthCookie之外的其它HTTP API时,通过HTTP请求头的
Cookie
字段传递认证标识Token,Link IoT Edge会验证该认证标识Token是否具有对应API的访问权限。
API列表
- 身份认证类
API名称 API描述 CreateAuthCookie 创建认证Cookie。 DeleteAuthCookie 删除认证Cookie。 - 设备管理类
API名称 API描述 ListThings 列出设备及其状态。 SetThingProperties 设置设备属性。 GetThingProperties 获取设备属性。 CallThingServices 调用设备服务。 BulkActions 对设备进行批量操作。 - 函数计算类
API名称 API描述 InvokeFunction 调用指定的函数。
文档内容是否对您有帮助?