以下是物联网平台API列表。

产品管理的API

API描述
CreateProduct创建产品。
UpdateProduct修改产品信息。
QueryProductList查询产品列表。
QueryProduct查询产品详细信息。
DeleteProduct删除指定产品。
CreateProductTags创建产品标签。
UpdateProductTags更新产品标签。
DeleteProductTags删除产品标签。
ListProductTags查询产品的所有标签。
ListProductByTags根据标签查询产品。
UpdateProductFilterConfig更新产品下设备上报的属性去重规则。
ReleaseProduct发布指定产品。
CancelReleaseProduct取消指定产品的发布。

设备管理的API

API描述
RegisterDevice注册设备。
QueryClientIds一型一密免注册场景下，查看单个设备的标识列表。
TransformClientId一型一密免注册场景下，若设备包含多个设备标识，需指定一个正确的设备标识，以防止非法的设备登录。
DeleteClientIds一型一密免注册场景下，若单个设备的标识个数超出限制（5个），可删除设备下的所有标识。
QueryDeviceInfo查询指定设备的基本信息（设备ID、设备证书和备注名称）。
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模块版本列表。
ImportDevice在MQTT云网关产品下单个导入设备。
BatchImportDevice在MQTT云网关产品下批量导入设备。
BatchCheckImportDevice批量校验在MQTT云网关产品下批量导入的设备。
QueryImportedDeviceByApplyId根据申请批次ID（ApplyId）查询批量导入的设备列表。
BatchImportVehicleDevice在JT/T 808协议云网关产品下批量导入设备。
BatchCheckVehicleDevice批量校验导入的JT/T 808协议云网关设备。
QueryVehicleDevice查询JT/T 808协议云网关设备信息。

设备分发的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查询指定设备的原始服务调用记录。
ClearDeviceDesiredProperty清空设备下已设置的期望属性值。

云产品流转（旧版）的API

API描述
ListRule查询规则列表。
CreateRule创建规则。
GetRule查询规则信息。
UpdateRule修改规则。
DeleteRule删除规则。
ListDataSourceItem分页查询规则引擎中指定数据源下的Topic列表。
ListRuleActions查询规则动作列表。
GetRuleAction查询规则动作信息。
CreateRuleAction创建规则动作。
UpdateRuleAction更新规则动作。
DeleteRuleAction删除规则动作。
StartRule启动规则。
StopRule停止规则。

云产品流转（新版）的API

API描述
CreateParser创建解析器。
UpdateParser更新解析器名称和描述。
ListParser查询解析器列表信息，包括解析器基本信息、启动状态、创建时间和修改时间。
GetParser询指定解析器的详细信息，包括解析器基本信息、解析脚本、运行状态和关联的数据源等。
DeleteParser删除解析器。
CreateParserDataSource创建待流转的数据源。
UpdateParserDataSource更新数据源名称和描述信息。
ListParserDataSource查询所有数据源列表。
GetParserDataSource查询指定数据源的详细信息。
DeleteParserDataSource删除已创建的数据源。
CreateDataSourceItem为已创建的数据源添加Topic。
ListDataSourceItem分页查询指定数据源下的Topic列表。
DeleteDataSourceItem删除指定数据源下的指定Topic。
CreateDestination创建数据源流转的数据目的。
UpdateDestination更新数据目的名称、操作类型和描述信息。
ListDestination查询已创建的数据目的列表。
GetDestination查询指定数据目的详细信息。
DeleteDestination删除已创建的数据目的。
AttachParserDataSource为解析器关联指定数据源。
ListParserDestination查询指定解析器关联的数据目的列表。
DetachParserDataSource删除解析器中的指定数据源。
AttachDestination为解析器关联指定数据目的。
DetachDestination删除解析器中的指定数据目的。
SaveScript编辑并保存解析器的脚本草稿。
PublishScript发布指定解析器中的脚本。
StartParser启动解析器。
StopParser停止解析器运行。

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向指定设备发布消息，支持向指定产品下订阅了指定自定义Topic的在线设备发送广播消息。
BatchPub通过自定义Topic向指定产品下的多个设备批量发送消息。
SubscribeTopic为指定设备订阅Topic。
QueryDeviceSubTopic查询设备已订阅的Topic列表。
UpdateTopicConfig设置自定义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模块列表。
ConfirmOTATask批量确认处于待确认状态的设备升级作业。
ListOTAUnfinishedTaskByDevice查询指定设备下，未完成状态的设备升级作业列表。