以下是物联网平台 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 解禁设备。
BatchCheckDeviceNames 批量检查设备名称。
BatchRegisterDeviceWithApplyId 根据 ApplyId 批量申请设备。
BatchRegisterDevice 批次申请特定数量设备。
QueryBatchRegisterDeviceStatus 查询批量注册设备状态。
QueryPageByApplyId 查询批次设备列表。
QueryDeviceEventData 查询设备的事件历史数据。
QueryDevicePropertyData 查询设备的属性历史数据。
QueryDevicePropertiesData 批量查询指定设备的多个属性的历史数据。
QueryDeviceServiceData 获取设备的服务记录历史数据。
InvokeThingService 调用设备的服务。
InvokeThingsService 批量调用设备的服务。
QueryDevicePropertyStatus 查询设备的属性快照。
SetDeviceProperty 设置设备的属性。
SetDevicesProperty 批量设置设备属性。
SaveDeviceProp 设置设备标签。
QueryDeviceProp 查询设备标签列表。
DeleteDeviceProp 删除设备标签。
GetThingTopo 查询网关设备或子设备所具有的拓扑关系。
NotifyAddThingTopo 通知网关增加设备拓扑关系。
BatchAddThingTopo 批量添加设备拓扑关系。
RemoveThingTopo 移除网关设备或子设备所具有的拓扑关系。
QueryDeviceStatistics 获取设备的统计数量。
GetGatewayBySubDevice 根据挂载的子设备信息查询对应的网关设备信息。
QueryDeviceByTags 根据标签查询设备。
SetDeviceDesiredProperty 为指定设备批量设置期望属性值。
QueryDeviceDesiredProperty 查询指定设备的期望属性值。
QueryDeviceFileList 查询指定设备上传到物联网平台的所有文件。
QueryDeviceFile 查询指定设备上传到物联网平台的指定文件信息。
DeleteDeviceFile 删除指定设备上传到物联网平台的指定文件。
BatchUpdateDeviceNickname 批量更新设备备注名称。
QueryLoRaJoinPermissions 查询账号下的LoRaWAN入网凭证列表。
CreateLoRaNodesTask 创建批量注册LoRaWAN设备的任务。
GetLoraNodesTask 查询批量注册LoRaWAN设备任务的状态。
QueryDeviceCert 查询单个设备的X.509证书。
QueryCertUrlByApplyId 查询批量注册设备的X.509证书下载链接。
QueryDeviceByStatus 根据设备状态查询设备列表。

物模型相关API

API 描述
ListThingTemplates 获取物联网平台预定义的产品品类列表。
GetThingTemplate 查询指定品类的标准物模型信息。
ListThingModelVersion 获取指定产品的物模型历史版本列表。
GetThingModelTsl 查询指定产品的物模型。
ImportThingModelTsl 为指定产品导入物模型TSL。
QueryThingModel 查看指定产品的物模型中的功能定义详情。
CopyThingModel 复制指定产品的物模型到目标产品。
DeleteThingModel 删除指定产品物模型中的指定功能。
PublishThingModel 发布指定产品的物模型。

分组管理相关API

API 描述
CreateDeviceGroup 创建分组。
DeleteDeviceGroup 删除分组。
UpdateDeviceGroup 修改分组信息。
QueryDeviceGroupInfo 查询分组详情。
QueryDeviceGroupList 分页查询分组列表。
BatchAddDeviceGroupRelations 添加设备到分组。
BatchDeleteDeviceGroupRelations 删除分组中已添加的指定设备。
SetDeviceGroupTags 添加或更新分组标签。
QueryDeviceGroupTagList 查询分组标签列表。
QueryDeviceGroupByDevice 查询指定设备所在的分组列表。
QuerySuperDeviceGroup 根据子分组ID查询父分组信息。
QueryDeviceListByDeviceGroup 查询分组中的设备列表。
QueryDeviceGroupByTags 根据标签查询设备分组。

规则引擎相关API

API 描述
ListRule 查询规则列表。
CreateRule 创建规则。
GetRule 查询规则信息。
UpdateRule 修改规则。
DeleteRule 删除规则。
ListRuleActions 查询规则动作列表。
GetRuleAction 查询规则动作信息。
CreateRuleAction 创建规则动作。
UpdateRuleAction 更新规则动作。
DeleteRuleAction 删除规则动作。
StartRule 启动规则。
StopRule 停止规则。

Topic管理相关API

API 描述
QueryProductTopic 查询产品Topic类。
CreateProductTopic 创建产品Topic类。
UpdateProductTopic 修改产品Topic类。
DeleteProductTopic 删除产品Topic类。
CreateTopicRouteTable 添加Topic路由表。
QueryTopicRouteTable 查询Topic路由表。
QueryTopicReverseRouteTable 查询Topic反向路由表。
DeleteTopicRouteTable 删除Topic路由表。

消息通信相关API

API 描述
Pub 发布消息到Topic。
RRpc 发消息给设备，并同步返回响应。
PubBroadcast 发布广播消息。

设备影子相关 API

API 描述
GetDeviceShadow 查询设备影子。
UpdateDeviceShadow 更新设备影子。

固件升级相关API

API 描述
GenerateOTAUploadURL 生成固件文件的上传对象存储的信息。
CreateOTAFirmware 创建固件。
DeleteOTAFirmware 删除指定固件。
ListOTAFirmware 查询固件列表。
QueryOTAFirmware 查询指定固件的详细信息。
CreateOTAVerifyJob 创建固件验证批次。
CreateOTAStaticUpgradeJob 创建静态批量升级批次。
CreateOTADynamicUpgradeJob 创建动态升级批次。
ListOTAJobByFirmware 获取固件下的升级批次列表。
QueryOTAJob 查询指定升级批次的详情。
CancelOTAStrategyByJob 取消动态升级批次所关联的动态升级策略。
CancelOTATaskByDevice 取消指定固件下状态为待升级的设备升级作业。
ListOTATaskByJob 查询指定升级批次下的设备升级作业列表。
ListOTATaskByDevice 查询设备所关联的升级作业列表。