更新时间:2023-04-13 GMT+08:00
分享

API列表

应用安全接入

API

说明

鉴权

应用服务器进行认证鉴权,获取接入Token。

刷新token

在Token过期前,获取新的Token。

设备管理

API

说明

注册设备(验证码方式)

在物联网平台注册一个设备,仅适用于使用LWM2M/CoAP协议或Agent Lite接入的设备。

刷新设备密钥

在物联网平台修改设备的唯一标识。

修改设备信息

在物联网平台修改设备的信息。

删除设备

在物联网平台删除一个设备。

查询设备激活状态

查询设备在物联网平台的激活状态,确定设备是否已接入平台。

查询设备影子

查询设备影子上的设备配置信息及设备最近一次上报的数据。

修改设备影子

修改设备影子配置信息。

数据采集

API

说明

查询单个设备信息

查询物联网平台中一个设备的详细信息,包括厂商、型号、版本、状态和服务属性等。

批量查询设备信息列表

根据指定条件查询物联网平台中多个设备的详细信息,包括厂商、型号、版本、状态和服务属性等。

查询设备历史数据

查询设备上报到平台的历史数据。

查询设备影子历史数据

查询设备影子历史配置记录。

查询设备服务能力

查询设备的产品模型中定义的设备服务能力信息。

订阅管理

API

说明

订阅平台业务数据

向物联网平台订阅设备相关的业务信息,如设备注册、设备数据上报、设备状态变更等。

订阅平台管理数据

向物联网平台订阅设备相关的管理数据,如软件升级、固件升级等。

查询单个订阅

在物联网平台查询某个订阅的配置信息。

批量查询订阅

根据指定条件查询物联网平台中的订阅配置信息。

删除单个订阅

在物联网平台删除指定的订阅配置,取消订阅。

批量删除订阅

根据指定条件在物联网平台删除多个订阅配置,取消订阅。

命令下发

API

说明

创建设备命令

向设备下发控制命令,仅适用于使用LWM2M/CoAP协议接入的设备。

查询设备命令

根据指定条件查询下发命令的状态及内容信息。

修改设备命令

把某个PENDING状态的命令修改为CANCELED状态,即撤销命令。

创建设备命令撤销任务

撤销某个设备的所有未下发的命令。

查询设备命令撤销任务

查询设备命令撤销任务的详细信息和执行状态。

设备服务调用

向设备下发控制命令,仅适用于使用MQTT协议接入的设备。

批量处理

API

说明

创建批量任务

创建设备的批量操作任务,当前仅支持给批量设备下发缓存命令。

查询指定批量任务信息

查询某个批量任务的信息,包括任务的当前状态、子任务信息。

查询批量任务的子任务信息

查询某个批量任务中子任务的详情信息,如任务的执行状态、任务内容等。

设备组管理

API

说明

创建设备组

在物联网平台上创建一个设备组。

删除设备组

在物联网平台上删除一个设备组。

修改设备组

修改某个设备组的信息,如设备组名称、设备组的设备数量限制等。

查询设备组详情

根据指定条件查询物联网平台中的设备组信息。

查询指定设备组

查询某个设备组的信息。

查询指定设备组成员

查询某个设备组的设备成员列表信息。

增加设备组成员

向某个设备组添加设备。

删除设备组成员

从某个设备组删除设备。

设备升级

API

说明

查询版本包列表

查询物联网平台中的版本升级包列表信息。

查询指定版本包

查询物联网平台中某个版本升级包的信息。

删除指定版本包

在物联网平台上删除某个的版本升级包。

创建软件升级任务

为设备创建软件升级任务,当前仅支持对NB-IoT设备进行软件版本升级。

创建固件升级任务

为设备创建固件升级任务,当前仅支持对NB-IoT设备进行固件版本升级。

查询指定升级任务结果

查询某个升级任务的详细信息。

查询指定升级任务子任务详情

查询某个升级任务的各个子任务详细信息。

查询升级任务列表

根据指定条件查询物联网平台中的升级任务列表信息。

相关文档