检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
联网平台(服务端)分别与应用端和设备端建立安全隧道连接,当两条连接都建立成功后,才具备远程运维能力。建立安全隧道的WebSocket连接的接口详见建立安全隧道的WebSocket连接。 消息交互:建立连接后,应用端与设备端之间使用基于WebSocket的安全隧道协议进行消息通信,
项目源码及更多详细的使用指导请参考华为云开发者 Node.js 软件开发工具包(Node.js SDK)。 推荐您使用API在线调试工具API Explorer ,API Explorer 支持快速调试和检索,调试API的同时,可以根据您的参数实时生成各种开发语言的SDK示例代码,方便您直接根据示例代码使用SDK。
则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于创建产品接口,您可以从接口的请求部分看到所需的请求参数及参数说明。
解绑标签 功能介绍 应用服务器可调用此接口为指定资源解绑标签。当前支持标签的资源有Device(设备)。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/tags/unbind-resource 表1 路径参数 参数 是否必选 参数类型
删除设备策略 功能介绍 应用服务器可调用此接口在物联网平台上删除指定策略,注意:删除策略同时会解绑该策略下所有绑定对象。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/device-policies/{policy_id} 表1
查询设备代理详情 功能介绍 应用服务器可调用此接口查询物联网平台中指定设备代理的详细信息。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/device-proxies/{proxy_id} 表1 路径参数 参数 是否必选 参数类型 描述
权限与授权项 权限与授权说明 授权项列表 父主题: 应用侧API参考
查询产品 功能介绍 应用服务器可调用此接口查询已在物联网平台的创建的指定产品模型详细信息,包括产品模型的服务、属性、命令等。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/products/{product_id} 表1 路径参数 参数
设备时间同步响应 功能描述 平台向设备发送时间同步响应,携带设备发送时间device_send_time。当平台收到时间server_recv_time 后,向设备发送时间server_send_time 。 例如,设备收到的设备侧时间为device_recv_time ,则设备计算自己的准确时间为:
查询设备隧道 功能介绍 用户可通过该接口查询某项目中的某个设备隧道,查看该设备隧道的信息与连接情况。应用服务器可调用此接口向平台查询设备隧道建立情况。 该API接口在基础版不支持。 具体应用可见“设备远程登录”功能,请参见设备远程登录。 调用方法 请参见如何调用API。 URI GET /v
删除网桥 功能介绍 应用服务器可调用此接口在物联网平台上删除指定网桥。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/bridges/{bridge_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是
查询网桥列表 功能介绍 应用服务器可调用此接口在物联网平台查询网桥列表。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/bridges 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见
绑定设备策略 功能介绍 应用服务器可调用此接口在物联网平台上为批量设备绑定目标策略,目前支持绑定目标类型为:设备、产品,当目标类型为产品时,该产品下所有设备都会生效。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/device-po
是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数
解冻设备 功能介绍 应用服务器可调用此接口解冻设备,解除冻结后,设备可以连接上线。该接口仅支持解冻单个设备,如需批量解冻设备,请参见 创建批量任务。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/devices/{device_id}/unfreeze
关闭设备隧道 功能介绍 应用服务器可通过该接口关闭某个设备隧道。关闭后可以再次连接。 该API接口在基础版不支持。 具体应用可见“设备远程登录”功能,请参见设备远程登录。 调用方法 请参见如何调用API。 URI PUT /v5/iot/{project_id}/tunnels/{tunnel_id}
是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 响应参数
修改规则状态 功能介绍 应用服务器可调用此接口修改物联网平台中指定规则的状态,激活或者去激活规则。 调用方法 请参见如何调用API。 URI PUT /v5/iot/{project_id}/rules/{rule_id}/status 表1 路径参数 参数 是否必选 参数类型 描述
重置设备密钥 功能介绍 应用服务器可调用此接口重置设备密钥,携带指定密钥时平台将设备密钥重置为指定的密钥,不携带密钥时平台将自动生成一个新的随机密钥返回。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/devices/{device_id}/action
网关上报子设备属性 接口说明 用于批量设备上报属性数据给平台。网关设备可以用此接口同时上报最多50个子设备的属性数据。 URI 请求方法 POST URI /v5/devices/{device_id}/sys/gateway/sub-devices/properties/report