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

重要 在基础型企业版实例下,仅支持使用产品管理设备管理服务端订阅云产品流转(新版)分组管理消息通信相关的部分API。详细说明,请参见对应API列表中最后一列说明。

产品管理的API

API 描述 基础型实例下是否支持
CreateProduct 创建产品。 是。
UpdateProduct 修改产品信息。 是。
QueryProductList 查询产品列表。 是。
QueryProduct 查询产品详细信息。 是。
DeleteProduct 删除指定产品。 是。
CreateProductTags 创建产品标签。 是。
UpdateProductTags 更新产品标签。 是。
DeleteProductTags 删除产品标签。 是。
ListProductTags 查询产品的所有标签。 是。
ListProductByTags 根据标签查询产品。 是。
UpdateProductFilterConfig 更新产品下设备上报的属性去重规则。 否。
QueryProductCertInfo 获取产品的X.509证书信息。 否。
SetProductCertInfo 设置产品的X.509证书信息。 否。
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 批量更新设备备注名称。 是。
QueryLoRaJoinPermissions 查询账号下的LoRaWAN入网凭证列表。 否。
CreateLoRaNodesTask 创建批量注册LoRaWAN设备的任务。 否。
GetLoraNodesTask 查询批量注册LoRaWAN设备任务的状态。 否。
QueryDeviceCert 查询单个设备的X.509证书。 否。
QueryCertUrlByApplyId 查询批量注册设备的X.509证书下载链接。 否。
QueryDeviceByStatus 根据设备状态查询设备列表。 否。
QueryDeviceBySQL 通过SQL语句快速搜索满足指定条件的设备。 否。
ListOTAModuleVersionsByDevice 查询设备上报过的OTA模块版本列表。 否。
ImportDevice 在MQTT云网关产品下单个导入设备。 否。
BatchImportDevice 在基础型实例或MQTT云网关产品下批量导入设备。 是。
BatchCheckImportDevice 批量校验导入的设备。 是。
QueryImportedDeviceByApplyId 根据申请批次ID(ApplyId)查询批量导入的设备列表。 是。

设备分发的API

API 描述 基础型实例下是否支持
CreateDeviceDistributeJob 创建设备分发任务,默认同时分发设备所属产品。 否。
CreateProductDistributeJob 创建产品分发任务,分发指定产品到指定的目标实例。
QueryDeviceDistributeDetail 获取设备分发任务执行完成后的结果信息。
QueryDeviceDistributeJob 获取设备分发任务的详细信息。
ListDeviceDistributeJob 获取设备分发任务列表。
DeleteDeviceDistributeJob 删除设备分发任务。
ListDistributedDevice 查询已分发的设备列表。
ListDistributedProduct 查询已分发的产品列表。

安全隧道的API

API 描述 基础型实例下是否支持
CreateDeviceTunnel 创建安全隧道。 否。
CloseDeviceTunnel 关闭状态为已打开的安全隧道。
DeleteDeviceTunnel 删除状态为已关闭的安全隧道。
QueryDeviceTunnel 查询单个安全隧道的详细信息,包括安全隧道的所属设备、创建时间、ID、连接状态等。

分组管理的API

API 描述 基础型实例下是否支持
CreateDeviceGroup 创建静态分组。 是。
CreateDeviceDynamicGroup 创建动态分组。 否。
DeleteDeviceGroup 删除静态分组。 是。
DeleteDeviceDynamicGroup 删除动态分组。 否。
UpdateDeviceGroup 修改分组信息。 是。
QueryDeviceGroupInfo 查询分组详情。 是。
QueryDeviceGroupList 分页查询分组列表。 是。
QueryDynamicGroupDevices 查询动态分组下的设备列表。 否。
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 描述 基础型实例下是否支持
CreateJob 创建设备任务。 否。
GenerateFileUploadURL 生成文件上传到OSS的信息。
UpdateJob 更新任务下作业配置。
QueryJob 查询指定设备任务的详细信息。
ListJob 查询阿里云账号下的任务列表。
CancelJob 取消任务的执行。
DeleteJob 删除设备任务。
ListTask 查询指定任务或指定设备下的作业列表。
QueryTask 查询指定任务下的作业。
QueryJobStatistics 查询指定任务下各状态作业的统计信息。
RerunJob 重新执行指定设备任务下,所有已超时和失败的设备作业。

云产品流转(旧版)的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向指定设备发布消息。 是。
BatchPub 通过自定义Topic向指定产品下的多个设备批量发送消息。 是。
QueryMessageInfo 查询设备上下行消息的详情,包括消息的内容、消息的产生时间、发送消息的Topic等。 是。
SubscribeTopic 为指定设备订阅Topic。 否。
QueryDeviceSubTopic 查询设备已订阅的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 查询指定设备下,未完成状态的设备升级作业列表。

数据存储API

API 描述 基础型实例下是否支持
WriteDevicesHotStorageData 将设备自定义Topic数据写入热数据存储空间。 否。
QueryDevicesHotStorageDataStatus 查询设备热数据的快照数据。
QueryDevicesHotStorageData 查询设备热数据的时序数据。

音视频通信服务的API

API 描述 基础型实例下是否支持
BindLicenseProduct 为指定产品授权License。
BindLicenseDevice 为指定产品下批量设备授权License
CheckBindLicenseDeviceProgress 根据批量授权设备接口返回的唯一ID(CheckProgressId)查询授权的进度。
QueryLicenseDeviceList 查询授权License的设备列表。
UnbindLicenseProduct 取消指定产品的License授权。

IoT孪生引擎的API

API 描述 基础型实例下是否支持
ImportDTData 触发孪生体的数据映射配置,实现数据到孪生节点的映射。

千里传音API

API 描述 基础型实例下是否支持
CreateSpeech 创建语料。 否。
UpdateSpeech 更新语料,包括语料的播报声音、播报速度和音量大小等。
GetSpeechVoice 获取语料播报声音。
TestSpeech 试听语料。
QuerySpeech 查询语料详情,包括语料的播报声音、语料类型和音量大小等。
QuerySpeechList 查询语料列表。
PushSpeech 推送语料到设备。
DeleteSpeech 删除语料。
QuerySolutionDeviceGroupPage 查询项目下的分组列表。
QuerySpeechPushJob 查询语料推送任务列表。
QuerySpeechPushJobDevice 查询指定语料推送任务下的设备。
QuerySpeechPushJobSpeech 查询语料推送任务下的语料详情,包括语料的播报声音、语料类型和语料文本等。
SpeechByCombination 组合播报设备中的语料。
SyncSpeechByCombination 同步组合播报设备中的语料。
SpeechBySynthesis 下发动态播报内容到设备进行播报。
QuerySpeechDevice 查询播报设备的可用空间。
QueryDeviceSpeech 查询设备的语料列表。
GetSpeechDeviceDetail 查询播报设备的详情,包括设备的状态、设备的可用空间等。
DeleteDeviceSpeech 删除设备中的语料。
ShareSpeechByCombination 推送共享音频到设备播报。
AddShareTaskDevice 添加设备到语料分享任务。
QueryShareTaskDeviceList 查询语料分享任务的设备列表。
DeleteShareTaskDevice 删除语料分享任务中设备。
QuerySpeechLicenseDeviceList 查询千里传音License设备列表。
GetSpeechLicenseDeviceStatistics 查询千里传音License设备统计信息。
QueryProjectShareDeviceList 查询项目的分享设备列表。
PageQuerySpeechBroadcastHour 分页查询千里传音中共享播报的小时数据信息。
CountSpeechBroadcastHour 分页查询千里传音中共享播报的小时数据量。
PageQuerySharedSpeechOpen 被共享方分页查询共享的语料。

寄雁传书服务API

API 描述 基础型实例下是否支持
PrintByTemplate 根据寄雁传书控制台创建的小票打印模板完成小票打印。 否。

声码服务API

API 描述 基础型实例下是否支持
CreateSoundCode 创建声码。 否。
DeleteSoundCode 删除声码。
QuerySoundCodeList 查询声码列表。
GetSoundCodeAudio 获取声码音频下载地址。
CreateSoundCodeSchedule 创建声码排程。
UpdateSoundCodeSchedule 更新声码排程。
DeleteSoundCodeSchedule 删除声码排程。
QuerySoundCodeScheduleList 查询声码排程列表。
GetSoundCodeSchedule 查询声码排程详情。
UpdateSchedulePeriod 更新声码排程时间段。
CreateSchedulePeriod 创建声码排程时间段。
DeleteSchedulePeriod 删除声码排程时间段。
QuerySchedulePeriodList 查询声码排程时间段列表。
CreateSoundCodeLabel 为指定排程创建声码标签。
UpdateSoundCodeLabel 更新声码标签。
DeleteSoundCodeLabel 删除声码标签。
QuerySoundCodeLabelList 查询指定排程的声码标签列表。
BatchCreateSoundCodeLabel 为指定排程批量创建声码标签。
BatchCreateSoundCodeLabelWithLabels 为指定排程批量创建指定声码标签。
QuerySoundCodeLabelBatchList 查询指定排程的声码标签批次列表。
QuerySoundCodeLabelBatchFailedResult 查询指定声码标签批次下创建失败的声码标签列表。
PackageSoundCodeLabelBatchAudio 获取声码标签批次音频打包地址。
RetrySoundCodeLabelBatch 重启声码标签批次。

位置服务API

API 描述 基础型实例下是否支持
GisQueryDeviceLocation 查询设备位置信息。 否。
GisSearchDeviceTrace 查询设备轨迹详情。

图文识别服务API

API 描述 基础型实例下是否支持
RecognizeCarNum 通过图文识别技术识别出图片中的车牌号码。 否。
RecognizePictureGeneral 通过图文识别技术识别出图片中的文字信息。

开通服务的API

OpenIotService:开通物联网平台服务。

其他API

物联网数据分析服务的云端API调用说明,请参见数据开发API

物联网边缘计算的云端API调用说明,请参见边缘计算API