以下是物联网平台API列表。
产品管理相关API
| API | 描述 |
|---|---|
| CreateProduct | 创建产品。 |
| UpdateProduct | 修改产品信息。 |
| QueryProductList | 查询产品列表。 |
| QueryProduct | 查询产品详细信息。 |
| DeleteProduct | 删除指定产品。 |
| CreateProductTags | 创建产品标签。 |
| UpdateProductTags | 更新产品标签。 |
| DeleteProductTags | 删除产品标签。 |
| ListProductTags | 查询产品的所有标签。 |
| ListProductByTags | 根据标签查询产品。 |
| UpdateProductFilterConfig | 更新产品下设备上报的属性去重规则。 |
设备管理相关API
| API | 描述 |
|---|---|
| RegisterDevice | 注册设备。 |
| QueryDeviceDetail | 查询设备详情。 |
| BatchQueryDeviceDetail | 批量查询设备详情。 |
| QueryDevice | 查询产品的设备列表。 |
| DeleteDevice | 删除设备。 |
| GetDeviceStatus | 获取设备的运行状态。 |
| BatchGetDeviceState | 批量获取设备状态。 |
| DisableThing | 禁用设备。 |
| EnableThing | 解禁设备。 |
| ResetThing | 重置设备。 |
| BatchCheckDeviceNames | 批量自定义设备名称，物联网平台将检查名称的合法性。 |
| BatchRegisterDeviceWithApplyId | 根据ApplyId批量申请设备。 |
| BatchRegisterDevice | 批次申请特定数量设备。 |
| QueryBatchRegisterDeviceStatus | 查询批量注册设备状态。 |
| QueryPageByApplyId | 查询批次设备列表。 |
| SaveDeviceProp | 设置设备标签。 |
| QueryDeviceProp | 查询设备标签列表。 |
| DeleteDeviceProp | 删除设备标签。 |
| GetThingTopo | 查询网关设备的子设备列表。 |
| NotifyAddThingTopo | 通知网关增加设备拓扑关系。 |
| BatchAddThingTopo | 批量添加设备拓扑关系。 |
| RemoveThingTopo | 移除网关设备或子设备所具有的拓扑关系。 |
| QueryDeviceStatistics | 获取设备的统计数量。 |
| GetGatewayBySubDevice | 根据挂载的子设备信息查询对应的网关设备信息。 |
| QueryDeviceByTags | 根据标签查询设备。 |
| QueryDeviceFileList | 查询指定设备上传到物联网平台的所有文件。 |
| QueryDeviceFile | 查询指定设备上传到物联网平台的指定文件信息。 |
| DeleteDeviceFile | 删除指定设备上传到物联网平台的指定文件。 |
| BatchUpdateDeviceNickname | 批量更新设备备注名称。 |
| QueryDeviceByStatus | 根据设备状态查询设备列表。 |
| ListOTAModuleVersionsByDevice | 查询设备上报过的OTA模块版本列表。 |
设备分发相关API
| API | 描述 |
|---|---|
| CreateDeviceDistributeJob | 创建设备分发任务，默认同时分发设备所属产品。 |
| CreateProductDistributeJob | 创建产品分发任务，将指定产品分发到指定的目标实例。 |
| QueryDeviceDistributeDetail | 获取设备分发任务执行完成后的结果信息。 |
| QueryDeviceDistributeJob | 获取设备分发任务的详细信息。 |
| ListDeviceDistributeJob | 获取设备分发任务列表。 |
| DeleteDeviceDistributeJob | 删除设备分发任务。 |
| ListDistributedDevice | 查询已分发的设备列表。 |
| ListDistributedProduct | 查询已分发的产品列表。 |
分组管理相关API
| API | 描述 |
|---|---|
| CreateDeviceGroup | 创建分组。 |
| DeleteDeviceGroup | 删除分组。 |
| UpdateDeviceGroup | 修改分组信息。 |
| QueryDeviceGroupInfo | 查询分组详情。 |
| QueryDeviceGroupList | 分页查询分组列表。 |
| BatchAddDeviceGroupRelations | 添加设备到分组。 |
| BatchDeleteDeviceGroupRelations | 删除分组中已添加的指定设备。 |
| SetDeviceGroupTags | 添加或更新分组标签。 |
| QueryDeviceGroupTagList | 查询分组标签列表。 |
| QueryDeviceGroupByDevice | 查询指定设备所在的分组列表。 |
| QuerySuperDeviceGroup | 根据子分组ID查询父分组信息。 |
| QueryDeviceListByDeviceGroup | 查询分组中的设备列表。 |
| QueryDeviceGroupByTags | 根据标签查询设备分组。 |
物模型管理相关API
| API | 描述 |
|---|---|
| CreateThingModel | 为指定产品的物模型新增功能，支持定义物模型扩展描述。 |
| UpdateThingModel | 更新指定产品物模型中的单个功能，支持更新物模型扩展描述。 |
| QueryThingModel | 查看指定产品的物模型中的功能定义详情。 |
| CopyThingModel | 复制指定产品的物模型到目标产品。 |
| PublishThingModel | 发布指定产品的物模型。 |
| DeleteThingModel | 删除指定产品物模型中的指定功能。 |
| ListThingTemplates | 获取物联网平台预定义的产品品类列表。 |
| GetThingTemplate | 查询指定品类的标准物模型信息。 |
| ListThingModelVersion | 获取指定产品的物模型历史版本列表。 |
| GetThingModelTsl | 查询指定产品的物模型。 |
| ImportThingModelTsl | 为指定产品导入物模型TSL，暂不支持扩展描述配置。 |
| QueryThingModelPublished | 查看指定产品的已发布物模型中的功能定义详情。 |
| GetThingModelTslPublished | 查询指定产品的已发布物模型TSL。 |
| QueryThingModelExtendConfig | 导出指定产品的物模型扩展描述配置。 |
| QueryThingModelExtendConfigPublished | 导出已发布物模型的扩展描述配置。 |
| CreateThingScript | 为指定产品提交数据解析脚本。 |
| UpdateThingScript | 修改指定产品的数据解析脚本。 |
| GetThingScript | 查询指定产品的数据解析脚本。 |
物模型使用相关API
| API | 描述 |
|---|---|
| SetDeviceProperty | 设置设备的属性。 |
| SetDevicesProperty | 批量设置设备属性。 |
| InvokeThingService | 调用设备的服务。 |
| InvokeThingsService | 批量调用设备的服务。 |
| QueryDevicePropertyData | 查询设备的属性历史数据。 |
| QueryDevicePropertiesData | 批量查询指定设备的多个属性的历史数据。 |
| QueryDeviceEventData | 查询设备的事件历史数据。 |
| QueryDeviceServiceData | 获取设备的服务记录历史数据。 |
| SetDeviceDesiredProperty | 为指定设备批量设置期望属性值。 |
| QueryDeviceDesiredProperty | 查询指定设备的期望属性值。 |
| QueryDevicePropertyStatus | 查询指定设备的属性快照。 |
| QueryDeviceOriginalPropertyStatus | 查询指定设备的原始属性快照。 |
| QueryDeviceOriginalPropertyData | 查询指定设备的原始属性记录。 |
| QueryDeviceOriginalEventData | 查询指定设备的原始事件记录。 |
| QueryDeviceOriginalServiceData | 查询指定设备的原始服务调用记录。 |
云产品流转相关API
| API | 描述 |
|---|---|
| ListRule | 查询规则列表。 |
| CreateRule | 创建规则。 |
| GetRule | 查询规则信息。 |
| UpdateRule | 修改规则。 |
| DeleteRule | 删除规则。 |
| ListRuleActions | 查询规则动作列表。 |
| GetRuleAction | 查询规则动作信息。 |
| CreateRuleAction | 创建规则动作。 |
| UpdateRuleAction | 更新规则动作。 |
| DeleteRuleAction | 删除规则动作。 |
| StartRule | 启动规则。 |
| StopRule | 停止规则。 |
Topic管理相关API
| API | 描述 |
|---|---|
| CreateProductTopic | 创建产品自定义Topic类。 |
| UpdateProductTopic | 修改产品自定义Topic类。 |
| QueryProductTopic | 查询产品自定义Topic类。 |
| DeleteProductTopic | 删除产品自定义Topic类。 |
| CreateTopicRouteTable | 添加Topic路由表。 |
| QueryTopicRouteTable | 查询Topic路由表。 |
| QueryTopicReverseRouteTable | 查询Topic反向路由表。 |
| DeleteTopicRouteTable | 删除Topic路由表。 |
服务端订阅相关API
| API | 描述 |
|---|---|
| CreateSubscribeRelation | 创建MNS或AMQP服务端订阅。 |
| UpdateSubscribeRelation | 修改MNS或AMQP服务端订阅。 |
| QuerySubscribeRelation | 查询MNS或AMQP服务端订阅。 |
| DeleteSubscribeRelation | 删除MNS或AMQP服务端订阅。 |
| CreateConsumerGroup | 创建一个消费组，用于创建AMQP服务端订阅。 |
| UpdateConsumerGroup | 修改消费组名称。 |
| QueryConsumerGroupByGroupId | 根据消费组ID查询消费组详情。 |
| QueryConsumerGroupList | 查询用户所有消费组列表，或按消费组名称进行模糊查询。 |
| QueryConsumerGroupStatus | 使用AMQP服务端订阅时，查询某个消费组的状态，包括在线客户端信息、消息消费速率、消息堆积数、最近消息消费时间。 |
| ResetConsumerGroupPosition | 使用AMQP服务端订阅时，清空某个消费组的堆积消息。 |
| DeleteConsumerGroup | 删除消费组。 |
| CreateConsumerGroupSubscribeRelation | 在AMQP订阅中添加一个消费组。 |
| DeleteConsumerGroupSubscribeRelation | 从AMQP订阅中的多个消费组移除指定消费组。 |
消息通信相关API
| API | 描述 |
|---|---|
| RRpc | 向指定设备发送请求消息，并同步返回响应。 |
| PubBroadcast | 向指定产品所有设备，或向订阅了指定Topic的所有设备发布广播消息。 |
| Pub | 通过自定义Topic向指定设备发布消息。 |
| BatchPub | 通过自定义Topic向指定产品下的多个设备批量发送消息。
说明 该接口目前仅支持白名单用户使用，如需使用请先提交工单反馈。
|
设备影子相关 API
| API | 描述 |
|---|---|
| GetDeviceShadow | 查询设备影子。 |
| UpdateDeviceShadow | 更新设备影子。 |
OTA升级相关API
| API | 描述 |
|---|---|
| GenerateOTAUploadURL | 生成升级包文件上传到OSS的URL及详细信息。 |
| GenerateDeviceNameListURL | 生成设备列表文件上传到OSS的URL及详细信息。在创建静态升级批次时，设备列表文件可用于指定要升级的设备。 |
| CreateOTAFirmware | 添加升级包。 |
| DeleteOTAFirmware | 删除指定升级包。 |
| ListOTAFirmware | 查询升级包列表。 |
| QueryOTAFirmware | 查询指定升级包的详细信息。 |
| CreateOTAVerifyJob | 创建升级包验证批次。 |
| CreateOTAStaticUpgradeJob | 创建静态升级批次。 |
| CreateOTADynamicUpgradeJob | 创建动态升级批次。 |
| ListOTAJobByFirmware | 获取升级包下的升级批次列表。 |
| ListOTAJobByDevice | 获取设备所在的升级包升级批次列表。 |
| ListOTATaskByJob | 查询指定升级批次下的设备升级作业列表。 |
| QueryOTAJob | 查询指定升级批次的详情。 |
| CancelOTAStrategyByJob | 取消动态升级批次所关联的动态升级策略。 |
| CancelOTATaskByDevice | 取消指定升级包下状态为待升级的设备升级作业。 |
| CancelOTATaskByJob | 取消指定批次下的设备升级作业。 |
| CreateOTAModule | 创建产品的OTA模块。 |
| UpdateOTAModule | 修改OTA模块别名、描述。 |
| DeleteOTAModule | 删除自定义OTA模块。 |
| ListOTAModuleByProduct | 查询产品下的OTA模块列表。 |