设备接入

API 参考

文档版本 17

发布日期 2020-04-14

华为技术有限公司

版权所有 © 华为技术有限公司 2020。 保留一切权利。

非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传播。 商标声明

和其他华为商标均为华为技术有限公司的商标。本文档提及的其他所有商标或注册商标，由各自的所有人拥有。 注意

您购买的产品、服务或特性等应受华为公司商业合同和条款的约束，本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内。除非合同另有约定，华为公司对本文档内容不做任何明示或默示的声明或保证。

由于产品版本升级或其他原因，本文档内容会不定期进行更新。除非另有约定，本文档仅作为使用指导，本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保。

文档版本 17 (2020-04-14) 版权所有 © 华为技术有限公司 i

目 录

1 应用侧 API 参考..........................................................................................................................11.1 使用前必读................................................................................................................................................................................. 11.2 如何调用 API.............................................................................................................................................................................. 21.2.1 构造请求.................................................................................................................................................................................. 21.2.2 返回结果.................................................................................................................................................................................. 51.3 API 列表....................................................................................................................................................................................... 51.4 订阅管理................................................................................................................................................................................... 101.4.1 查询订阅列表....................................................................................................................................................................... 101.4.2 创建订阅................................................................................................................................................................................ 151.4.3 查询订阅................................................................................................................................................................................ 181.4.4 修改订阅................................................................................................................................................................................ 211.4.5 删除订阅................................................................................................................................................................................ 241.4.6 推送通知................................................................................................................................................................................ 261.4.6.1 设备激活通知....................................................................................................................................................................261.4.6.2 设备数据变化通知........................................................................................................................................................... 281.4.6.3 设备消息状态变更通知.................................................................................................................................................. 311.5 标签管理................................................................................................................................................................................... 321.5.1 绑定标签................................................................................................................................................................................ 321.5.2 解绑标签................................................................................................................................................................................ 341.5.3 按标签查询资源................................................................................................................................................................... 361.6 批量任务................................................................................................................................................................................... 391.6.1 查询批量任务列表.............................................................................................................................................................. 391.6.2 创建批量任务....................................................................................................................................................................... 451.6.3 查询批量任务....................................................................................................................................................................... 501.7 设备 CA 证书管理................................................................................................................................................................... 561.7.1 获取设备 CA 证书列表....................................................................................................................................................... 561.7.2 上传设备 CA 证书............................................................................................................................................................... 601.7.3 删除设备 CA 证书............................................................................................................................................................... 631.7.4 验证设备 CA 证书............................................................................................................................................................... 651.8 设备组管理............................................................................................................................................................................... 671.8.1 查询设备组列表................................................................................................................................................................... 671.8.2 添加设备组........................................................................................................................................................................... 701.8.3 查询设备组........................................................................................................................................................................... 73

设备接入API 参考 目 录

文档版本 17 (2020-04-14) 版权所有 © 华为技术有限公司 ii

1.8.4 修改设备组........................................................................................................................................................................... 751.8.5 删除设备组........................................................................................................................................................................... 771.8.6 管理设备组中的设备.......................................................................................................................................................... 791.8.7 查询设备组设备列表.......................................................................................................................................................... 811.9 设备消息................................................................................................................................................................................... 841.9.1 查询设备消息....................................................................................................................................................................... 841.9.2 下发设备消息....................................................................................................................................................................... 871.9.3 查询指定消息 id 的消息.................................................................................................................................................... 901.10 产品管理................................................................................................................................................................................. 921.10.1 查询产品列表.....................................................................................................................................................................921.10.2 创建产品............................................................................................................................................................................. 961.10.3 查询产品........................................................................................................................................................................... 1071.10.4 修改产品........................................................................................................................................................................... 1121.10.5 删除产品........................................................................................................................................................................... 1231.11 设备管理.............................................................................................................................................................................. 1251.11.1 查询设备列表.................................................................................................................................................................. 1251.11.2 创建设备........................................................................................................................................................................... 1301.11.3 查询设备........................................................................................................................................................................... 1381.11.4 修改设备........................................................................................................................................................................... 1421.11.5 删除设备........................................................................................................................................................................... 1471.11.6 重置设备密钥.................................................................................................................................................................. 1481.12 设备影子.............................................................................................................................................................................. 1501.12.1 查询设备影子数据..........................................................................................................................................................1501.12.2 配置设备影子预期数据................................................................................................................................................. 1531.13 设备命令.............................................................................................................................................................................. 1571.13.1 下发设备命令.................................................................................................................................................................. 1571.14 设备属性.............................................................................................................................................................................. 1601.14.1 查询设备属性.................................................................................................................................................................. 1601.14.2 修改设备属性.................................................................................................................................................................. 1621.15 规则管理.............................................................................................................................................................................. 1641.15.1 查询规则列表.................................................................................................................................................................. 1651.15.2 创建规则........................................................................................................................................................................... 1781.15.2.1 创建设备数据规则（单个设备）............................................................................................................................ 1781.15.2.2 创建定时规则（重复触发）..................................................................................................................................... 2001.15.2.3 创建定时规则（按天触发）..................................................................................................................................... 2221.15.3 查询规则........................................................................................................................................................................... 2441.15.4 修改规则........................................................................................................................................................................... 2561.15.5 删除规则........................................................................................................................................................................... 2811.15.6 修改规则状态.................................................................................................................................................................. 2831.16 错误码列表.......................................................................................................................................................................... 2851.17 附录....................................................................................................................................................................................... 2961.17.1 状态码............................................................................................................................................................................... 296

设备接入API 参考 目 录

文档版本 17 (2020-04-14) 版权所有 © 华为技术有限公司 iii

1.17.2 获取项目 ID..................................................................................................................................................................... 299

2 设备侧 MQTT 接口参考........................................................................................................ 3012.1 使用前必读............................................................................................................................................................................ 3012.2 设备与平台间通信方式概述.............................................................................................................................................. 3022.3 Topic 定义.............................................................................................................................................................................. 3032.4 设备连接鉴权........................................................................................................................................................................ 3052.5 设备属性................................................................................................................................................................................. 3052.5.1 设备属性上报.....................................................................................................................................................................3062.5.2 网关批量设备属性上报................................................................................................................................................... 3072.5.3 平台设置设备属性............................................................................................................................................................ 3082.5.4 平台查询设备属性............................................................................................................................................................ 3102.5.5 设备侧获取平台的设备影子数据.................................................................................................................................. 3112.6 设备命令................................................................................................................................................................................. 3132.6.1 平台命令下发.....................................................................................................................................................................3132.7 设备消息................................................................................................................................................................................. 3152.7.1 设备消息上报.....................................................................................................................................................................3152.7.2 平台消息下发.....................................................................................................................................................................3162.8 网关与子设备管理............................................................................................................................................................... 3162.8.1 平台通知网关子设备新增............................................................................................................................................... 3162.8.2 平台通知网关子设备删除............................................................................................................................................... 3182.8.3 网关同步子设备列表........................................................................................................................................................3202.8.4 网关更新子设备状态........................................................................................................................................................3212.9 软固件升级............................................................................................................................................................................ 3222.9.1 平台下发获取版本信息通知...........................................................................................................................................3222.9.2 设备上报软固件版本........................................................................................................................................................3232.9.3 平台下发升级通知............................................................................................................................................................ 3242.9.4 设备上报升级状态............................................................................................................................................................ 326

3 历史 API.................................................................................................................................. 3283.1 接口演进指导........................................................................................................................................................................ 3283.1.1 演进说明............................................................................................................................................................................. 3283.1.2 应用侧接口差异说明........................................................................................................................................................3293.1.3 设备侧 MQTT 接口差异说明......................................................................................................................................... 3433.1.4 SDK 差异说明.................................................................................................................................................................... 3473.2 应用侧 API 参考.................................................................................................................................................................... 3473.2.1 使用前必读......................................................................................................................................................................... 3473.2.2 如何调用 API...................................................................................................................................................................... 3483.2.2.1 构造请求.......................................................................................................................................................................... 3483.2.2.2 返回结果.......................................................................................................................................................................... 3513.2.3 API 列表.............................................................................................................................................................................. 3523.2.4 应用安全接入.....................................................................................................................................................................3553.2.4.1 鉴权...................................................................................................................................................................................3553.2.4.2 刷新 token...................................................................................................................................................................... 357

设备接入API 参考 目 录

文档版本 17 (2020-04-14) 版权所有 © 华为技术有限公司 iv

3.2.5 设备管理............................................................................................................................................................................. 3593.2.5.1 注册设备（验证码方式）............................................................................................................................................3593.2.5.2 注册设备（密码方式）................................................................................................................................................ 3663.2.5.3 刷新设备密钥................................................................................................................................................................. 3703.2.5.4 修改设备信息................................................................................................................................................................. 3753.2.5.5 删除设备.......................................................................................................................................................................... 3803.2.5.6 删除子设备......................................................................................................................................................................3823.2.5.7 查询设备激活状态.........................................................................................................................................................3833.2.5.8 修改设备影子................................................................................................................................................................. 3853.2.5.9 查询设备影子................................................................................................................................................................. 3893.2.5.10 注册 LoRa 网关............................................................................................................................................................3953.2.5.11 注册 LoRa 节点............................................................................................................................................................3973.2.5.12 查询单个 LoRa 网关信息.......................................................................................................................................... 4013.2.5.13 删除 LoRa 网关............................................................................................................................................................4033.2.5.14 查询单个 LoRa 节点信息.......................................................................................................................................... 4053.2.5.15 删除 LoRa 节点............................................................................................................................................................4073.2.6 数据采集............................................................................................................................................................................. 4093.2.6.1 查询单个设备信息.........................................................................................................................................................4093.2.6.2 批量查询设备信息.........................................................................................................................................................4153.2.6.3 查询设备历史数据.........................................................................................................................................................4233.2.6.4 查询设备影子历史数据................................................................................................................................................ 4273.2.6.5 查询设备服务能力.........................................................................................................................................................4313.2.7 订阅管理............................................................................................................................................................................. 4373.2.7.1 订阅平台业务数据.........................................................................................................................................................4373.2.7.2 订阅平台管理数据.........................................................................................................................................................4403.2.7.3 查询单个订阅................................................................................................................................................................. 4423.2.7.4 批量查询订阅................................................................................................................................................................. 4443.2.7.5 删除单个订阅................................................................................................................................................................. 4483.2.7.6 批量删除订阅................................................................................................................................................................. 4503.2.8 推送通知............................................................................................................................................................................. 4543.2.8.1 注册设备通知................................................................................................................................................................. 4543.2.8.2 绑定设备通知................................................................................................................................................................. 4583.2.8.3 设备信息变化通知.........................................................................................................................................................4623.2.8.4 设备数据变化通知.........................................................................................................................................................4663.2.8.5 设备数据批量变化通知................................................................................................................................................ 4683.2.8.6 设备服务能力变化通知................................................................................................................................................ 4703.2.8.7 设备服务能力增加通知................................................................................................................................................ 4713.2.8.8 设备服务能力删除通知................................................................................................................................................ 4723.2.8.9 删除设备通知................................................................................................................................................................. 4743.2.8.10 设备消息确认通知...................................................................................................................................................... 4753.2.8.11 设备命令响应通知...................................................................................................................................................... 4773.2.8.12 命令状态变化通知...................................................................................................................................................... 478

设备接入API 参考 目 录

文档版本 17 (2020-04-14) 版权所有 © 华为技术有限公司 v

3.2.8.13 规则事件通知............................................................................................................................................................... 4803.2.8.14 设备影子状态变更通知............................................................................................................................................. 4823.2.8.15 软件升级状态变更通知............................................................................................................................................. 4833.2.8.16 软件升级结果通知...................................................................................................................................................... 4853.2.8.17 固件升级状态变更通知............................................................................................................................................. 4863.2.8.18 固件升级结果通知...................................................................................................................................................... 4883.2.9 命令下发............................................................................................................................................................................. 4893.2.9.1 创建设备命令................................................................................................................................................................. 4893.2.9.2 查询设备命令................................................................................................................................................................. 4963.2.9.3 修改设备命令................................................................................................................................................................. 5023.2.9.4 批量创建设备命令.........................................................................................................................................................5073.2.9.5 创建设备命令撤销任务................................................................................................................................................ 5083.2.9.6 查询设备命令撤销任务................................................................................................................................................ 5133.2.9.7 设备命令下发................................................................................................................................................................. 5203.2.10 批量处理........................................................................................................................................................................... 5243.2.10.1 创建批量任务............................................................................................................................................................... 5243.2.10.2 查询指定批量任务信息............................................................................................................................................. 5293.2.10.3 查询批量任务的子任务信息..................................................................................................................................... 5343.2.11 设备组管理.......................................................................................................................................................................5373.2.11.1 创建设备组................................................................................................................................................................... 5373.2.11.2 删除设备组................................................................................................................................................................... 5403.2.11.3 修改设备组................................................................................................................................................................... 5423.2.11.4 查询设备组列表.......................................................................................................................................................... 5453.2.11.5 查询指定设备组.......................................................................................................................................................... 5483.2.11.6 查询指定设备组成员.................................................................................................................................................. 5503.2.11.7 增加设备组成员.......................................................................................................................................................... 5533.2.11.8 删除设备组成员.......................................................................................................................................................... 5563.2.12 设备升级........................................................................................................................................................................... 5583.2.12.1 查询版本包列表.......................................................................................................................................................... 5583.2.12.2 查询指定版本包.......................................................................................................................................................... 5623.2.12.3 删除指定版本包.......................................................................................................................................................... 5643.2.12.4 创建软件升级任务...................................................................................................................................................... 5663.2.12.5 创建固件升级任务...................................................................................................................................................... 5703.2.12.6 查询指定任务信息...................................................................................................................................................... 5753.2.12.7 查询指定任务的子任务详情..................................................................................................................................... 5803.2.12.8 查询任务列表............................................................................................................................................................... 5833.2.13 设备接入应用侧 API 参考............................................................................................................................................ 5883.2.13.1 使用前必读................................................................................................................................................................... 5893.2.13.2 如何调用 API................................................................................................................................................................ 5893.2.13.2.1 构造请求.................................................................................................................................................................... 5893.2.13.2.2 返回结果.................................................................................................................................................................... 5913.2.13.3 API 列表.........................................................................................................................................................................592

设备接入API 参考 目 录

文档版本 17 (2020-04-14) 版权所有 © 华为技术有限公司 vi

3.2.13.4 应用接入认证............................................................................................................................................................... 5943.2.13.4.1 鉴权............................................................................................................................................................................. 5943.2.13.5 产品管理....................................................................................................................................................................... 5953.2.13.5.1 查询产品列表........................................................................................................................................................... 5963.2.13.5.2 查询指定产品的详细信息......................................................................................................................................5983.2.13.6 设备管理....................................................................................................................................................................... 6003.2.13.6.1 创建设备.................................................................................................................................................................... 6003.2.13.6.2 查询设备状态........................................................................................................................................................... 6033.2.13.6.3 删除设备.................................................................................................................................................................... 6053.2.13.6.4 修改设备信息........................................................................................................................................................... 6063.2.13.6.5 注册 LoRa 网关........................................................................................................................................................ 6083.2.13.6.6 注册 LoRa 节点........................................................................................................................................................ 6113.2.13.6.7 查询单个 LoRa 网关信息....................................................................................................................................... 6153.2.13.6.8 删除 LoRa 网关........................................................................................................................................................ 6173.2.13.6.9 查询单个 LoRa 节点信息....................................................................................................................................... 6193.2.13.6.10 删除 LoRa 节点......................................................................................................................................................6213.2.13.7 数据采集....................................................................................................................................................................... 6233.2.13.7.1 查询设备信息列表...................................................................................................................................................6233.2.13.7.2 查询单个设备信息...................................................................................................................................................6273.2.13.7.3 查询设备的服务能力.............................................................................................................................................. 6303.2.13.8 设备指令下发............................................................................................................................................................... 6353.2.13.8.1 给设备服务下发命令.............................................................................................................................................. 6353.2.13.8.2 查询设备命令状态...................................................................................................................................................6383.3 设备侧 MQTT 接口参考..................................................................................................................................................... 6393.3.1 使用前必读......................................................................................................................................................................... 6393.3.2 MQTT CONNECT 连接鉴权...........................................................................................................................................6423.3.3 设备上报数据.....................................................................................................................................................................6433.3.4 设备接收命令.....................................................................................................................................................................6443.3.5 设备响应命令.....................................................................................................................................................................645

4 历史 SDK.................................................................................................................................6474.1 SDK 参考................................................................................................................................................................................ 6474.1.1 SDK 介绍............................................................................................................................................................................. 6474.1.2 应用侧 JAVA SDK API 参考............................................................................................................................................6524.1.2.1 SDK 使用说明................................................................................................................................................................. 6524.1.2.2 API 列表........................................................................................................................................................................... 6564.1.2.3 应用安全接入................................................................................................................................................................. 6594.1.2.3.1 鉴权............................................................................................................................................................................... 6594.1.2.3.2 刷新 token................................................................................................................................................................... 6604.1.2.3.3 定时刷新 token.......................................................................................................................................................... 6624.1.2.3.4 停止定时刷新 token..................................................................................................................................................6634.1.2.4 设备管理.......................................................................................................................................................................... 6634.1.2.4.1 注册设备（验证码方式）........................................................................................................................................ 664

设备接入API 参考 目 录

文档版本 17 (2020-04-14) 版权所有 © 华为技术有限公司 vii

4.1.2.4.2 刷新设备密钥.............................................................................................................................................................. 6694.1.2.4.3 修改设备信息.............................................................................................................................................................. 6734.1.2.4.4 删除设备...................................................................................................................................................................... 6784.1.2.4.5 查询设备激活状态..................................................................................................................................................... 6804.1.2.4.6 查询设备影子.............................................................................................................................................................. 6834.1.2.4.7 修改设备影子.............................................................................................................................................................. 6874.1.2.5 数据采集.......................................................................................................................................................................... 6904.1.2.5.1 查询单个设备信息..................................................................................................................................................... 6904.1.2.5.2 批量查询设备信息列表............................................................................................................................................ 6954.1.2.5.3 查询设备历史数据..................................................................................................................................................... 7014.1.2.5.4 查询设备影子历史数据............................................................................................................................................ 7044.1.2.5.5 查询设备服务能力..................................................................................................................................................... 7074.1.2.6 订阅管理.......................................................................................................................................................................... 7114.1.2.6.1 订阅平台业务数据..................................................................................................................................................... 7124.1.2.6.2 订阅平台管理数据..................................................................................................................................................... 7154.1.2.6.3 查询单个订阅.............................................................................................................................................................. 7174.1.2.6.4 批量查询订阅.............................................................................................................................................................. 7184.1.2.6.5 删除单个订阅.............................................................................................................................................................. 7224.1.2.6.6 批量删除订阅.............................................................................................................................................................. 7234.1.2.7 消息推送.......................................................................................................................................................................... 7254.1.2.7.1 注册设备通知.............................................................................................................................................................. 7254.1.2.7.2 绑定设备通知.............................................................................................................................................................. 7294.1.2.7.3 设备信息变化通知..................................................................................................................................................... 7334.1.2.7.4 设备数据变化通知..................................................................................................................................................... 7364.1.2.7.5 批量设备数据变化通知............................................................................................................................................ 7384.1.2.7.6 设备服务信息变化通知............................................................................................................................................ 7404.1.2.7.7 删除设备通知.............................................................................................................................................................. 7424.1.2.7.8 设备消息确认通知..................................................................................................................................................... 7434.1.2.7.9 设备命令响应通知..................................................................................................................................................... 7454.1.2.7.10 设备事件通知........................................................................................................................................................... 7474.1.2.7.11 增加设备模型通知...................................................................................................................................................7494.1.2.7.12 删除设备模型通知...................................................................................................................................................7514.1.2.7.13 设备影子状态变更通知.......................................................................................................................................... 7534.1.2.7.14 软件升级状态变更通知.......................................................................................................................................... 7544.1.2.7.15 软件升级结果变更通知.......................................................................................................................................... 7564.1.2.7.16 固件升级状态变更通知.......................................................................................................................................... 7584.1.2.7.17 固件升级结果变更通知.......................................................................................................................................... 7594.1.2.7.18 NB 设备命令状态变化通知................................................................................................................................... 7614.1.2.8 命令下发.......................................................................................................................................................................... 7634.1.2.8.1 创建设备命令.............................................................................................................................................................. 7634.1.2.8.2 查询设备命令.............................................................................................................................................................. 7684.1.2.8.3 修改设备命令.............................................................................................................................................................. 774

设备接入API 参考 目 录

文档版本 17 (2020-04-14) 版权所有 © 华为技术有限公司 viii

4.1.2.8.4 创建设备命令撤销任务............................................................................................................................................ 7784.1.2.8.5 查询设备命令撤销任务............................................................................................................................................ 7824.1.2.8.6 设备服务调用.............................................................................................................................................................. 7874.1.2.9 批量处理.......................................................................................................................................................................... 7914.1.2.9.1 创建批量任务.............................................................................................................................................................. 7914.1.2.9.2 查询指定批量任务信息............................................................................................................................................ 7954.1.2.9.3 查询批量任务的子任务信息.................................................................................................................................... 7994.1.2.10 设备组管理................................................................................................................................................................... 8024.1.2.10.1 创建设备组................................................................................................................................................................ 8034.1.2.10.2 删除设备组................................................................................................................................................................ 8054.1.2.10.3 修改设备组................................................................................................................................................................ 8074.1.2.10.4 查询设备组详情....................................................................................................................................................... 8094.1.2.10.5 查询指定设备组....................................................................................................................................................... 8124.1.2.10.6 查询指定设备组成员.............................................................................................................................................. 8134.1.2.10.7 增加设备组成员....................................................................................................................................................... 8164.1.2.10.8 删除设备组成员....................................................................................................................................................... 8184.1.2.11 设备升级....................................................................................................................................................................... 8204.1.2.11.1 查询版本包列表....................................................................................................................................................... 8204.1.2.11.2 查询指定版本包....................................................................................................................................................... 8234.1.2.11.3 删除指定版本包....................................................................................................................................................... 8254.1.2.11.4 创建软件升级任务...................................................................................................................................................8264.1.2.11.5 创建固件升级任务...................................................................................................................................................8304.1.2.11.6 查询指定升级任务结果.......................................................................................................................................... 8354.1.2.11.7 查询指定升级任务子任务详情............................................................................................................................. 8384.1.2.11.8 查询升级任务列表...................................................................................................................................................8414.1.3 应用侧 Python SDK API 参考........................................................................................................................................8454.1.3.1 SDK 使用说明................................................................................................................................................................. 8454.1.3.2 API 列表........................................................................................................................................................................... 8474.1.3.3 应用安全接入................................................................................................................................................................. 8494.1.3.3.1 鉴权............................................................................................................................................................................... 8504.1.3.3.2 刷新 token................................................................................................................................................................... 8524.1.3.4 设备管理.......................................................................................................................................................................... 8544.1.3.4.1 注册设备（验证码方式）........................................................................................................................................ 8544.1.3.4.2 刷新设备密钥.............................................................................................................................................................. 8594.1.3.4.3 修改设备信息.............................................................................................................................................................. 8634.1.3.4.4 删除设备...................................................................................................................................................................... 8684.1.3.4.5 查询设备激活状态..................................................................................................................................................... 8704.1.3.4.6 查询设备影子.............................................................................................................................................................. 8724.1.3.4.7 修改设备影子.............................................................................................................................................................. 8774.1.3.5 数据采集.......................................................................................................................................................................... 8804.1.3.5.1 查询单个设备信息..................................................................................................................................................... 8804.1.3.5.2 批量查询设备信息列表............................................................................................................................................ 885

设备接入API 参考 目 录

文档版本 17 (2020-04-14) 版权所有 © 华为技术有限公司 ix

4.1.3.5.3 查询设备历史数据..................................................................................................................................................... 8904.1.3.5.4 查询设备影子历史数据............................................................................................................................................ 8944.1.3.5.5 查询设备服务能力..................................................................................................................................................... 8974.1.3.6 订阅管理.......................................................................................................................................................................... 9014.1.3.6.1 订阅平台业务数据..................................................................................................................................................... 9014.1.3.6.2 订阅平台管理数据..................................................................................................................................................... 9054.1.3.6.3 查询单个订阅.............................................................................................................................................................. 9074.1.3.6.4 批量查询订阅.............................................................................................................................................................. 9084.1.3.6.5 删除单个订阅.............................................................................................................................................................. 9124.1.3.6.6 批量删除订阅.............................................................................................................................................................. 9134.1.3.7 消息推送.......................................................................................................................................................................... 9154.1.3.7.1 注册设备通知.............................................................................................................................................................. 9154.1.3.7.2 绑定设备通知.............................................................................................................................................................. 9194.1.3.7.3 设备信息变化通知..................................................................................................................................................... 9234.1.3.7.4 设备数据变化通知..................................................................................................................................................... 9274.1.3.7.5 批量设备数据变化通知............................................................................................................................................ 9294.1.3.7.6 设备服务信息变化通知............................................................................................................................................ 9314.1.3.7.7 删除设备通知.............................................................................................................................................................. 9334.1.3.7.8 设备消息确认通知..................................................................................................................................................... 9344.1.3.7.9 设备命令响应通知..................................................................................................................................................... 9364.1.3.7.10 设备事件通知........................................................................................................................................................... 9394.1.3.7.11 增加设备模型通知...................................................................................................................................................9414.1.3.7.12 删除设备模型通知...................................................................................................................................................9434.1.3.7.13 设备影子状态变更通知.......................................................................................................................................... 9444.1.3.7.14 软件升级状态变更通知.......................................................................................................................................... 9464.1.3.7.15 软件升级结果变更通知.......................................................................................................................................... 9484.1.3.7.16 固件升级状态变更通知.......................................................................................................................................... 9504.1.3.7.17 固件升级结果变更通知.......................................................................................................................................... 9524.1.3.7.18 NB 设备命令状态变化通知................................................................................................................................... 9544.1.3.8 命令下发.......................................................................................................................................................................... 9554.1.3.8.1 创建设备命令.............................................................................................................................................................. 9564.1.3.8.2 查询设备命令.............................................................................................................................................................. 9614.1.3.8.3 修改设备命令.............................................................................................................................................................. 9664.1.3.8.4 创建设备命令撤销任务............................................................................................................................................ 9704.1.3.8.5 查询设备命令撤销任务............................................................................................................................................ 9744.1.3.8.6 设备服务调用.............................................................................................................................................................. 9794.1.3.9 批量处理.......................................................................................................................................................................... 9834.1.3.9.1 创建批量任务.............................................................................................................................................................. 9834.1.3.9.2 查询指定批量任务信息............................................................................................................................................ 9874.1.3.9.3 查询批量任务的子任务信息.................................................................................................................................... 9914.1.3.10 设备组管理................................................................................................................................................................... 9944.1.3.10.1 创建设备组................................................................................................................................................................ 995

设备接入API 参考 目 录

文档版本 17 (2020-04-14) 版权所有 © 华为技术有限公司 x

4.1.3.10.2 删除设备组................................................................................................................................................................ 9974.1.3.10.3 修改设备组................................................................................................................................................................ 9994.1.3.10.4 查询设备组详情.....................................................................................................................................................10014.1.3.10.5 查询指定设备组.....................................................................................................................................................10034.1.3.10.6 查询指定设备组成员............................................................................................................................................ 10054.1.3.10.7 增加设备组成员.....................................................................................................................................................10074.1.3.10.8 删除设备组成员.....................................................................................................................................................10104.1.3.11 设备升级..................................................................................................................................................................... 10124.1.3.11.1 查询版本包列表.....................................................................................................................................................10124.1.3.11.2 查询指定版本包.....................................................................................................................................................10154.1.3.11.3 删除指定版本包.....................................................................................................................................................10174.1.3.11.4 创建软件升级任务................................................................................................................................................ 10184.1.3.11.5 创建固件升级任务................................................................................................................................................ 10224.1.3.11.6 查询指定升级任务结果........................................................................................................................................10264.1.3.11.7 查询指定升级任务子任务详情...........................................................................................................................10294.1.3.11.8 查询升级任务列表................................................................................................................................................ 10324.1.4 设备侧 Agent Lite API 参考(C).................................................................................................................................. 10364.1.4.1 使用前必读................................................................................................................................................................... 10364.1.4.2 开发说明....................................................................................................................................................................... 10374.1.4.2.1 广播机制.................................................................................................................................................................... 10374.1.4.2.2 Json 组件使用说明.................................................................................................................................................. 10384.1.4.2.3 数据类型说明........................................................................................................................................................... 10414.1.4.3 直连设备接入............................................................................................................................................................... 10434.1.4.3.1 初始化 Agent Lite 资源......................................................................................................................................... 10434.1.4.3.2 释放 Agent Lite 资源..............................................................................................................................................10444.1.4.3.3 绑定配置.................................................................................................................................................................... 10444.1.4.3.4 设备绑定.................................................................................................................................................................... 10454.1.4.3.5 设备接收解绑定命令.............................................................................................................................................. 10494.1.4.3.6 登录参数配置........................................................................................................................................................... 10504.1.4.3.7 登录信息的加密算法配置（可选）.................................................................................................................... 10514.1.4.3.8 设备登录.................................................................................................................................................................... 10524.1.4.3.9 设备登出.................................................................................................................................................................... 10544.1.4.4 非直连设备管理.......................................................................................................................................................... 10544.1.4.4.1 添加设备.................................................................................................................................................................... 10544.1.4.4.2 更新设备状态........................................................................................................................................................... 10574.1.4.4.3 删除设备.................................................................................................................................................................... 10594.1.4.5 上报设备数据............................................................................................................................................................... 10614.1.4.6 接收设备命令............................................................................................................................................................... 10624.1.4.7 发布数据....................................................................................................................................................................... 10634.1.5 设备侧 Agent Lite API 参考(Android)..................................................................................................................... 10644.1.5.1 使用前必读................................................................................................................................................................... 10644.1.5.2 直连设备接入............................................................................................................................................................... 1065

设备接入API 参考 目 录

文档版本 17 (2020-04-14) 版权所有 © 华为技术有限公司 xi

4.1.5.2.1 初始化 Agent Lite 资源......................................................................................................................................... 10654.1.5.2.2 释放 Agent Lite 资源..............................................................................................................................................10664.1.5.2.3 绑定配置.................................................................................................................................................................... 10674.1.5.2.4 设备绑定.................................................................................................................................................................... 10684.1.5.2.5 设备接收解绑定命令.............................................................................................................................................. 10714.1.5.2.6 登录参数配置........................................................................................................................................................... 10724.1.5.2.7 登录信息的加密算法配置（可选）.................................................................................................................... 10734.1.5.2.8 设备登录.................................................................................................................................................................... 10744.1.5.2.9 设备登出.................................................................................................................................................................... 10774.1.5.3 非直连设备管理.......................................................................................................................................................... 10774.1.5.3.1 添加设备.................................................................................................................................................................... 10774.1.5.3.2 更新设备状态........................................................................................................................................................... 10814.1.5.3.3 删除设备.................................................................................................................................................................... 10834.1.5.4 上报设备数据............................................................................................................................................................... 10844.1.5.5 接收设备命令............................................................................................................................................................... 10864.1.5.6 发布数据....................................................................................................................................................................... 10874.1.6 设备侧 Agent Lite API 参考(Java)............................................................................................................................ 10894.1.6.1 使用前必读................................................................................................................................................................... 10894.1.6.2 观察者模式................................................................................................................................................................... 10904.1.6.3 直连设备接入............................................................................................................................................................... 10904.1.6.3.1 初始化 Agent Lite 资源......................................................................................................................................... 10904.1.6.3.2 释放 Agent Lite 资源..............................................................................................................................................10914.1.6.3.3 绑定配置.................................................................................................................................................................... 10924.1.6.3.4 设备绑定.................................................................................................................................................................... 10934.1.6.3.5 设备接收解绑定命令.............................................................................................................................................. 10964.1.6.3.6 登录参数配置........................................................................................................................................................... 10974.1.6.3.7 登录信息的加密算法配置（可选）.................................................................................................................... 10994.1.6.3.8 设备登录.................................................................................................................................................................... 11004.1.6.3.9 设备登出.................................................................................................................................................................... 11014.1.6.4 非直连设备管理.......................................................................................................................................................... 11024.1.6.4.1 添加设备.................................................................................................................................................................... 11024.1.6.4.2 更新设备状态........................................................................................................................................................... 11044.1.6.4.3 删除设备.................................................................................................................................................................... 11064.1.6.5 上报设备数据............................................................................................................................................................... 11074.1.6.6 接收设备命令............................................................................................................................................................... 11084.1.6.7 发布数据....................................................................................................................................................................... 1109

设备接入API 参考 目 录

文档版本 17 (2020-04-14) 版权所有 © 华为技术有限公司 xii

1 应用侧 API 参考1.1 使用前必读

1.2 如何调用API

1.3 API列表

1.4 订阅管理

1.5 标签管理

1.6 批量任务

1.7 设备CA证书管理

1.8 设备组管理

1.9 设备消息

1.10 产品管理

1.11 设备管理

1.12 设备影子

1.13 设备命令

1.14 设备属性

1.15 规则管理

1.16 错误码列表

1.17 附录

1.1 使用前必读

概述

物联网平台把自身丰富的管理能力通过API的形式对外开放，包括产品管理、设备管理、设备组管理、标签管理、设备CA证书管理、设备影子、设备命令、设备消息、设备属性、订阅管理、规则管理、批量任务等，帮助用户快速构筑基于物联网平台的行

设备接入API 参考 1 应用侧 API 参考

文档版本 17 (2020-04-14) 版权所有 © 华为技术有限公司 1

业应用。您可以根据本文档提供的API来使用物联网平台的服务，平台支持的全部API请参见API列表。

角色说明● 如果您是新用户，推荐使用应用侧API参考中的接口。● 如果您是老用户，想继续使用老接口，请使用应用侧API参考中的接口。● 如果您是老用户，想升级到新接口，请详细预览接口演进指导，完成改造后，再

使用应用侧API参考中的接口。

调用说明

物联网平台提供了RESTful（Representational State Transfer）风格API，支持您通过HTTPS请求调用，调用方法请参见如何调用API。

物联网平台的Endpoint请参见：地区和终端节点。

使用限制● API的演进会保持前向兼容性，若接口升级了版本，其旧版本接口可以继续使用，

但功能不再做增强，新增功能仅在新版本接口中提供。

● 应用在接收处理物联网平台发送的响应消息和推送消息时，需要兼容或忽略消息中的新增参数，不能因为消息中的新增参数导致应用的处理异常。

● 调用API的其他使用限制，请参见物联网平台的使用限制。

1.2 如何调用 API

1.2.1 构造请求本节介绍REST API请求的组成，并以调用物联网平台的查询产品和创建产品接口说明如何调用API，该API可用于获取用户的指定产品信息。

请求 URI请求URI由如下部分组成。

{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}

尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。

● URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。● Endpoint：指定承载REST服务端点的服务器域名或IP，不同服务不同区域的

Endpoint不同，您可以从地区和终端节点中获取。例如物联网平台在“华北-北京四�