检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
设备异步命令 下发异步设备命令 查询指定id的命令 父主题: 设备命令
删除设备隧道 功能介绍 用户可通过该接口删除某个设备隧道。删除后该通道不存在,无法再次连接。 该API接口在基础版不支持。 具体应用可见“设备远程登录”功能,请参见设备远程登录。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/tunnels/{tunnel_id}
是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数
routing rule 新建数据流转流控策略 查询数据流转流控策略列表 修改数据流转流控策略 查询数据流转流控策略 删除数据流转流控策略 父主题: API
创建设备隧道 功能介绍 用户可以通过该接口创建隧道(WebSocket协议),应用服务器和设备可以通过该隧道进行数据传输。 该API接口在基础版不支持。 该API调用后平台会向对应的MQTT/MQTTS设备下发隧道地址及密钥,同时给应用服务器也返回隧道地址及密钥,设备可以通过该地
创建批量任务 功能介绍 应用服务器可调用此接口为创建批量处理任务,对多个设备进行批量操作。当前支持批量软固件升级、批量创建设备、批量修改设备、批量删除设备、批量冻结设备、批量解冻设备、批量创建命令、批量创建消息任务。 调用方法 请参见如何调用API。 URI POST /v5/iot/
冻结设备 功能介绍 应用服务器可调用此接口冻结设备,设备冻结后不能再连接上线,可以通过解冻设备接口解除设备冻结。注意,当前仅支持冻结与平台直连的设备。该接口仅支持冻结单个设备,如需批量冻结设备,请参见 创建批量任务。 调用方法 请参见如何调用API。 URI POST /v5/iot
修改设备 功能介绍 应用服务器可调用此接口修改物联网平台中指定设备的基本信息。 调用方法 请参见如何调用API。 URI PUT /v5/iot/{project_id}/devices/{device_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
查询设备所有隧道 功能介绍 用户可通过该接口查询某项目下的所有设备隧道,以实现对设备管理。应用服务器可通过此接口向平台查询设备隧道建立的情况。 该API接口在基础版不支持。 具体应用可见“设备远程登录”功能,请参见设备远程登录。 调用方法 请参见如何调用API。 URI GET /v5/i
删除设备 功能介绍 应用服务器可调用此接口在物联网平台上删除指定设备。若设备下连接了非直连设备,则必须把设备下的非直连设备都删除后,才能删除该设备。该接口仅支持删除单个设备,如需批量删除设备,请参见 创建批量任务。 调用方法 请参见如何调用API。 URI DELETE /v5/i
修改规则 功能介绍 应用服务器可调用此接口修改物联网平台中指定规则的配置。 调用方法 请参见如何调用API。 URI PUT /v5/iot/{project_id}/rules/{rule_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
创建产品 功能介绍 应用服务器可调用此接口创建产品。此接口仅创建了产品,没有创建和安装插件,如果需要对数据进行编解码,还需要在平台开发和安装插件。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/products 表1 路径参数 参数
功能介绍 应用服务器可调用此接口重试批量任务,目前只支持task_type为firmwareUpgrade,softwareUpgrade。如果task_id对应任务已经成功、停止、正在停止、等待中或初始化中,则不可以调用该接口。如果请求Body为{},则调用该接口后会重新执行所有状态为失败、失败待重试和已停止的子任务。
下发广播消息 功能介绍 应用服务器可调用此接口向订阅了指定Topic的所有在线设备发布广播消息。应用将广播消息下发给平台后,平台会先返回应用响应结果,再将消息广播给设备。 注意: 此接口只适用于使用MQTT协议接入的设备。 调用方法 请参见如何调用API。 URI POST /v5/io
解绑标签 功能介绍 应用服务器可调用此接口为指定资源解绑标签。当前支持标签的资源有Device(设备)。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/tags/unbind-resource 表1 路径参数 参数 是否必选 参数类型
查询设备消息 功能介绍 应用服务器可调用此接口查询平台下发给设备的消息,平台为每个设备默认最多保存20条消息,超过20条后, 后续的消息会替换下发最早的消息。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/devices/{device_id}/messages
设备的产品模型中定义了物联网平台可向设备下发的属性,应用服务器可调用此接口向设备发送指令用以查询设备的实时属性, 并由设备将属性查询的结果同步返回给应用服务器。 注意:此接口适用于MQTT设备,暂不支持NB-IoT设备。 调用方法 请参见如何调用API。 URI GET /v5/iot/{projec
示例一:使用模板文件批量创建设备 场景描述 本章节指导用户通过API批量创建设备。API的调用方法参见如何调用API。 物联网平台支持通过请求参数和模板文件两种方式批量创建设备。本节以模板文件的方式为例,介绍如何批量创建设备。 涉及接口 查询产品列表:确定待创建设备所属的产品。 上传批量任
按标签查询资源 功能介绍 应用服务器可调用此接口查询绑定了指定标签的资源。当前支持标签的资源有Device(设备)。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/tags/query-resources 表1 路径参数 参数 是否必选
是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id