云端API列表

更新时间:2024-09-12 11:59:39下载pdf

产品管理的API

API 描述 备注
QueryProduct 查询产品详细信息
QueryProductList 查询产品列表

设备管理的API

API 描述 备注
RegisterDevice 单个注册设备
BatchRegisterDevice 批量注册多个设备
DisableThing 禁用设备
EnableThing 解禁设备
ResetThing 重置设备
DeleteDevice 删除设备
BatchUpdateDeviceNickname 批量更新设备的备注名称
QueryDeviceInfo 查询指定设备的基本信息(设备ID、设备证书和备注名称)
QueryDeviceDetail 查询设备详情
QueryDevice 查询产品的设备列表
GetDeviceStatus 获取设备的运行状态
BatchGetDeviceState 批量获取设备状态
QueryDeviceByStatus 根据设备状态查询设备列表
SaveDeviceProp 设置设备标签
QueryDeviceProp 查询设备标签列表
QueryDeviceByTags 根据标签查询设备
DeleteDeviceProp 删除设备标签
BatchAddThingTopo 批量添加设备拓扑关系
NotifyAddThingTopo 通知网关增加设备拓扑关系
GetThingTopo 查询网关设备的子设备列表
GetGatewayBySubDevice 根据挂载的子设备信息查询对应的网关设备信息
RemoveThingTopo 移除网关设备或子设备所具有的拓扑关系

物模型管理的API

API 描述 备注
QueryThingModelPublished 查看指定产品的已发布物模型中的功能定义详情

物模型使用的API

API 描述 备注
SetDeviceProperty 设置设备的属性
SetDevicesProperty 批量设置设备属性
InvokeThingService 调用设备的服务
InvokeThingsService 批量调用设备的服务
SetDeviceDesiredProperty 为指定设备批量设置期望属性值
QueryDeviceDesiredProperty 查询指定设备的期望属性值
QueryDevicePropertyStatus 查询指定设备的属性快照
ClearDeviceDesiredProperty 清空设备下已设置的期望属性值

OTA使用的API

API 描述 备注
GenerateOTAUploadURL 生成上传到OSS的升级包文件URL
CreateOTAFirmware 添加升级包
ModifyOTAFirmware 修改升级包信息,包括升级包名称、升级包描述和自定义信息
DeleteOTAFirmware 删除指定升级包
ListOTAFirmware 查询升级包列表
QueryOTAFirmware 查询指定升级包的详细信息
CreateOTAModule 创建OTA模块
UpdateOTAModule 修改OTA模块的别名、描述等
DeleteOTAModule 删除OTA模块
ListOTAModuleByProduct 查询产品下的OTA模块列表
CreateOTAVerifyJob 创建验证升级包批次
CreateOTAStaticUpgradeJob 创建静态升级批次
QueryOTAJob 查询指定升级批次的详情
CancelOTATaskByDevice 取消指定升级包下状态为待升级的设备升级作业
CancelOTATaskByJob 取消指定批次下的设备升级作业
ConfirmOTATask 批量确认处于待确认状态的设备升级作业
ListOTAJobByFirmware 获取升级包下的升级批次列表
ListOTAJobByDevice 获取设备所在的升级包升级批次列表
ListOTATaskByJob 查询指定升级批次下的设备升级作业列表
ListOTAUnfinishedTaskByDevice 查询指定设备下,未完成状态的设备升级作业列表
ListOTAModuleVersionsByDevice 查询设备上报过的OTA模块版本列表