物联网平台_API文档

物联网平台 - OpenAPI 概览2018-01-20
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
实例迁移
OpenAPI 名称描述操作
BatchGrayMigrationDevicehot调用该接口持续灰度迁移新增设备查看文档去调试
产品管理
OpenAPI 名称描述操作
CreateProducthot调用该接口创建产品查看文档去调试
CreateProductTags调用该接口为指定产品创建标签查看文档去调试
ReleaseProduct指定产品的发布查看文档去调试
QueryProduct调用该接口查询指定产品的详细信息查看文档去调试
QueryProductList调用该接口查看所有产品列表查看文档去调试
ListProductTags调用该接口查询指定产品的所有标签查看文档去调试
ListProductByTags调用该接口根据标签分页查询产品列表查看文档去调试
QueryProductCertInfo调用该接口获取产品的X.509证书信息查看文档去调试
UpdateProduct调用该接口修改指定产品的信息查看文档去调试
UpdateProductTags调用该接口更新产品标签查看文档去调试
UpdateProductFilterConfig更新产品下设备上报属性消息的去重规则。即时生效查看文档去调试
SetProductCertInfo调用该接口设置产品的X.509证书信息查看文档去调试
DeleteProduct调用该接口删除指定产品查看文档去调试
DeleteProductTags调用该接口删除产品标签查看文档去调试
CancelReleaseProduct调用该接口取消指定产品的发布查看文档去调试
设备管理
OpenAPI 名称描述操作
RegisterDevice调用该接口在指定产品下注册设备查看文档去调试
TransformClientId一型一密免注册场景下,若设备包含多个设备标识,需调用该接口指定一个正确的设备标识,以防止非法的设备登录查看文档去调试
BatchCheckDeviceNames调用该接口在指定产品下批量自定义设备名称。物联网平台将检查名称的合法性查看文档去调试
BatchRegisterDeviceWithApplyId根据申请批次ID(ApplyId)批量注册设备查看文档去调试
BatchRegisterDevice指定产品下批量注册多个设备(随机生成设备名)查看文档去调试
SaveDeviceProp调用该接口为指定设备设置标签查看文档去调试
NotifyAddThingTopo调用该接口通知网关设备增加拓扑关系查看文档去调试
BatchAddThingTopo调用该接口批量添加设备拓扑关系查看文档去调试
CreateLoRaNodesTask调用该接口生成批量注册LoRaWAN设备的任务查看文档去调试
ImportDevice调用该接口在MQTT云网关产品下单个导入设备查看文档去调试
BatchImportDevice调用该接口在MQTT型实例或MQTT云网关产品下批量导入设备查看文档去调试
BatchImportVehicleDevice调用该接口在云网关产品下批量导入设备查看文档去调试
QueryClientIds一型一密免注册场景下,调用该接口查看单个设备的标识列表查看文档去调试
QueryDeviceInfohot查询指定设备的基本信息(设备ID、设备证书和备注名称)查看文档去调试
QueryDeviceDetailhot调用该接口查询指定设备的详细信息查看文档去调试
BatchQueryDeviceDetail查询指定产品下多个设备的详细信息查看文档去调试
QueryDevice调用该接口查询指定产品下的所有设备列表查看文档去调试
GetDeviceStatus调用该接口查看指定设备的运行状态查看文档去调试
BatchGetDeviceState调用该接口批量查看同一产品下指定设备的运行状态查看文档去调试
QueryBatchRegisterDeviceStatus调用该接口查询批量注册设备申请的处理状态和结果查看文档去调试
QueryPageByApplyId调用该接口查询批量注册的设备信息查看文档去调试
GetGatewayBySubDevice根据挂载的子设备信息查询对应的网关设备信息查看文档去调试
QueryDeviceProp调用该接口查询指定设备的标签列表查看文档去调试
QueryDeviceByTags调用该接口通过标签查询设备查看文档去调试
GetThingTopo调用该接口查询指定网关设备的子设备列表查看文档去调试
QueryDeviceStatistics调用该接口查询设备统计数据,包括在线设备数、已激活设备数和已创建的设备总数查看文档去调试
QueryLoRaJoinPermissions调用该接口查询LoRaWAN入网凭证列表查看文档去调试
GetLoraNodesTask调用该接口查询批量注册LoRaWAN设备任务的状态查看文档去调试
QueryDeviceFileList查询指定设备上传到物联网平台的所有文件列表查看文档去调试
QueryDeviceFile查询指定设备上传到物联网平台的指定文件信息查看文档去调试
QueryDeviceCert调用该接口查询设备的X.509证书查看文档去调试
QueryCertUrlByApplyId获取批量注册设备的X.509证书下载链接查看文档去调试
QueryDeviceByStatus调用该接口根据设备状态查询设备列表查看文档去调试
QueryDeviceBySQL通过类SQL语句快速搜索满足指定条件的设备查看文档去调试
QueryImportedDeviceByApplyId调用该接口根据申请批次ID(ApplyId)查询批量导入的设备列表查看文档去调试
BatchCheckImportDevice调用该接口批量校验导入的设备查看文档去调试
BatchCheckVehicleDevice调用该接口批量校验导入的云网关设备查看文档去调试
QueryVehicleDevice调用该接口查询云网关设备信息查看文档去调试
DisableThing调用该接口禁用指定设备查看文档去调试
EnableThing调用该接口解除指定设备的禁用状态,即启用被禁用的设备查看文档去调试
ResetThing重置指定设备,重置直连设备一型一密状态,同时删除当前设备的拓扑关系查看文档去调试
BatchUpdateDeviceNickname调用该接口批量修改设备备注名称查看文档去调试
RemoveThingTopo调用该接口移除网关与子设备的拓扑关系查看文档去调试
DeleteClientIds一型一密免注册场景下,若单个设备的标识个数超出限制(5个),可调用该接口删除设备下的所有标识查看文档去调试
DeleteDeviceDeletes a device. You can also call this operation to delete the topological relationships between a gateway and the sub-devices that are connected to the gateway.查看文档去调试
DeleteDeviceProp调用该接口删除设备下的指定标签查看文档去调试
DeleteDeviceFile调用该接口删除指定设备上传到物联网平台的指定文件查看文档去调试
设备分发
OpenAPI 名称描述操作
CreateDeviceDistributeJob调用该接口创建设备分发任务,默认同时分发设备所属产品查看文档去调试
CreateProductDistributeJob调用该接口创建产品分发任务,将指定产品分发到指定的目标实例查看文档去调试
QueryDeviceDistributeDetail调用该接口获取设备分发任务执行完成后的结果信息查看文档去调试
QueryDeviceDistributeJob调用该接口获取设备分发任务的详细信息查看文档去调试
ListDeviceDistributeJob调用该接口获取设备分发任务列表查看文档去调试
ListDistributedDevice调用该接口查询已分发的设备列表查看文档去调试
ListDistributedProduct调用该接口查询已分发的产品列表查看文档去调试
QueryDeviceProvisioning调用该接口查询指定设备的分发结果查看文档去调试
DeleteDeviceDistributeJob调用该接口删除设备分发任务查看文档去调试
安全隧道管理
OpenAPI 名称描述操作
CreateDeviceTunnel为指定设备创建安全隧道查看文档去调试
QueryDeviceTunnel查询单个安全隧道的详细信息,包括安全隧道的所属设备、创建时间、ID、连接状态等查看文档去调试
CloseDeviceTunnel安全隧道在创建并使用完毕后,可以关闭状态为已打开的安全隧道查看文档去调试
DeleteDeviceTunnel已经关闭的安全隧道,可以调用该PI进行删除查看文档去调试
分组管理
OpenAPI 名称描述操作
CreateDeviceGroup新建设备分组查看文档去调试
CreateDeviceDynamicGroup创建动态分组,将符合动态分组条件的设备加入分组查看文档去调试
BatchAddDeviceGroupRelations调用该接口添加设备到某一分组(可批量添加设备)查看文档去调试
QueryDeviceGroupInfo调用该接口查询分组详情查看文档去调试
QueryDynamicGroupDevices查询动态分组下的设备列表查看文档去调试
QueryDeviceGroupList调用该接口分页查询分组列表查看文档去调试
QueryDeviceGroupTagList调用该接口查询分组标签列表查看文档去调试
QueryDeviceGroupByDevice调用该接口查询某一设备所在的分组列表查看文档去调试
QuerySuperDeviceGroup调用该接口根据子分组ID查询父分组信息查看文档去调试
QueryDeviceListByDeviceGroup调用该接口查询分组中的设备列表查看文档去调试
QueryDeviceGroupByTags调用该接口根据标签查询设备分组查看文档去调试
UpdateDeviceGroup调用该接口修改分组信息查看文档去调试
SetDeviceGroupTags批量增加、更新或者删除设备分组标签查看文档去调试
DeleteDeviceGroup调用该接口删除指定分组查看文档去调试
DeleteDeviceDynamicGroup逻辑删除设备动态分组,删除分组下设备分组关系查看文档去调试
BatchDeleteDeviceGroupRelations批量删除指定分组中的设备。该操作仅删除设备与分组的关联关系,不会删除设备本身查看文档去调试
物模型管理
OpenAPI 名称描述操作
CreateThingModel为指定产品的物模型新增功能,支持同时新增物模型扩展描述查看文档去调试
PublishThingModel调用该接口发布指定产品的物模型查看文档去调试
ImportThingModelTsl调用该接口为指定产品导入物模型查看文档去调试
CreateThingScript调用该接口为指定产品提交数据解析脚本查看文档去调试
QueryThingModel调用该接口查看指定产品物模型中的功能定义详情查看文档去调试
ListThingTemplates调用该接口获取物联网平台预定义的标准产品品类列表查看文档去调试
GetThingTemplate调用该接口查询指定品类的物模型信息查看文档去调试
ListThingModelVersion调用该接口获取指定产品的物模型版本列表查看文档去调试
GetThingModelTsl调用该接口查询指定产品的物模型TSL查看文档去调试
QueryThingModelPublished调用该接口查看指定产品的已发布物模型中的功能定义详情查看文档去调试
GetThingModelTslPublished调用该接口查询指定产品的已发布物模型TSL查看文档去调试
QueryThingModelExtendConfig查询物模型扩展描述配置查看文档去调试
QueryThingModelExtendConfigPublished调用该接口获取已发布物模型的扩展描述配置查看文档去调试
GetThingScript调用该接口查询指定产品的数据解析脚本查看文档去调试
UpdateThingModel更新指定产品物模型中的单个功能,支持更新物模型扩展描述查看文档去调试
CopyThingModel调用该接口复制指定产品的物模型到目标产品查看文档去调试
UpdateThingScript调用该接口修改指定产品的数据解析脚本查看文档去调试
DeleteThingModel调用该接口删除指定产品下物模型中的指定功能查看文档去调试
物模型使用
OpenAPI 名称描述操作
InvokeThingService调用该接口在单个设备上调用指定服务查看文档去调试
InvokeThingsService调用该接口批量调用设备服务查看文档去调试
QueryDevicePropertyDatahot调用该接口查询指定设备或数字孪生节点,在指定时间段内,单个属性的数据查看文档去调试
QueryDevicePropertiesData调用该接口查询指定设备或数字孪生节点,在指定时间段内,多个属性的数据查看文档去调试
QueryDeviceEventData调用该接口查询指定设备的事件记录查看文档去调试
QueryDeviceServiceData调用该接口查询指定设备的服务调用记录查看文档去调试
QueryDeviceDesiredProperty调用该接口查询指定设备的期望属性值查看文档去调试
QueryDevicePropertyStatushot调用该接口查询指定设备或数字孪生节点的所有属性快照查看文档去调试
QueryDeviceOriginalPropertyStatus查询指定设备本身上报的原始属性(通过和未通过物模型校验的所有属性)快照查看文档去调试
QueryDeviceOriginalPropertyData调用该接口查询指定设备本身上报的原始属性(通过和未通过物模型校验的所有属性)记录查看文档去调试
QueryDeviceOriginalEventData查询指定设备本身上报的原始事件(通过和未通过物模型校验的所有事件)记录查看文档去调试
QueryDeviceOriginalServiceData查询指定设备本身调用的原始服务(通过和未通过物模型校验的所有服务)记录查看文档去调试
SetDevicePropertyhot调用该接口为指定设备设置属性值查看文档去调试
SetDevicesProperty调用该接口批量设置设备属性值查看文档去调试
SetDeviceDesiredProperty调用该接口为指定设备批量设置期望属性值查看文档去调试
ClearDeviceDesiredProperty调用该接口清空设备已设置的期望属性值查看文档去调试
任务管理
OpenAPI 名称描述操作
CreateJob调用该接口创建设备任务查看文档去调试
GenerateFileUploadURL调用该接口生成文件上传到OSS的信息查看文档去调试
QueryJob查询任务详情查看文档去调试
ListJob调用该接口查询阿里云账号下的任务列表查看文档去调试
ListTask调用该接口查询指定任务或指定设备下的作业列表查看文档去调试
QueryTask调用该接口查询指定任务下的作业查看文档去调试
QueryJobStatistics调用该接口查询指定任务下各状态作业的统计信息查看文档去调试
UpdateJob调用该接口更新任务下作业配置查看文档去调试
CancelJob调用该接口取消任务的执行查看文档去调试
RerunJob重新执行指定设备任务下,所有已超时和失败的设备作业查看文档去调试
DeleteJob调用该接口删除任务查看文档去调试
Topic管理
OpenAPI 名称描述操作
CreateProductTopic调用该接口为指定产品创建自定义Topic类查看文档去调试
CreateTopicRouteTable调用该接口新建Topic间的消息路由关系查看文档去调试
QueryProductTopic调用该接口查询指定产品的自定义Topic类查看文档去调试
QueryTopicRouteTable查询向指定自定义Topic订阅消息的目标Topic,即指定Topic的路由表查看文档去调试
QueryTopicReverseRouteTable查询指定自定义Topic订阅的源Topic,即反向路由表查看文档去调试
UpdateProductTopic调用该接口更新指定的产品自定义Topic类查看文档去调试
DeleteProductTopic调用该接口删除指定的自定义Topic类查看文档去调试
DeleteTopicRouteTable调用该接口删除指定自定义Topic的路由关系查看文档去调试
云产品流转(旧版)
OpenAPI 名称描述操作
CreateRule调用该接口对指定Topic新建一个规则查看文档去调试
CreateRuleAction调用该接口在指定的规则下创建一个规则动作,定义将处理后的Topic数据,转发至物联网平台的其他Topic,或所支持的其他阿里云服务查看文档去调试
GetRule调用该接口查询指定规则的详细信息查看文档去调试
GetRuleAction调用该接口查询指定规则动作的详细信息查看文档去调试
ListRule调用该接口分页查询所有规则列表查看文档去调试
ListRuleActions调用该接口查询指定规则下的所有转发数据动作列表查看文档去调试
StartRule调用该接口启动指定的规则查看文档去调试
StopRule调用该接口停止指定的规则查看文档去调试
UpdateRule调用该接口修改指定的规则查看文档去调试
UpdateRuleAction调用该接口修改指定的规则动作查看文档去调试
DeleteRule调用该接口删除指定的规则查看文档去调试
DeleteRuleAction调用该接口删除指定的规则动作查看文档去调试
云产品流转(新版)
OpenAPI 名称描述操作
CreateParser调用该接口创建解析器查看文档去调试
CreateParserDataSource调用该接口创建待流转的数据源查看文档去调试
CreateDataSourceItem调用该接口为规则引擎中数据源添加Topic查看文档去调试
CreateDestination创建解析器流转数据目的查看文档去调试
AttachParserDataSource调用该接口为指定解析器关联指定数据源查看文档去调试
AttachDestination调用该接口为解析器关联指定数据目的查看文档去调试
PublishScript调用该接口发布指定解析器中的脚本查看文档去调试
SaveScript调用该接口编辑并保存解析器的脚本草稿查看文档去调试
StartParser调用该接口启动解析器查看文档去调试
ListParser调用该接口查询解析器列表信息,包括解析器基本信息、启动状态、创建时间和修改时间查看文档去调试
GetParser调用该接口查询指定解析器的详细信息,包括解析器基本信息、解析脚本、运行状态和关联的数据源等查看文档去调试
ListParserDataSource查询解析器数据源列表查看文档去调试
GetParserDataSource调用该接口查询指定数据源的详细信息查看文档去调试
ListDataSourceItem调用该接口分页查询规则引擎中指定数据源下的Topic列表查看文档去调试
ListDestination调用该接口查询已创建的数据目的列表查看文档去调试
GetDestination调用该接口查询指定数据目的详细信息查看文档去调试
ListParserDestination调用该接口查询指定解析器关联的数据目的列表查看文档去调试
UpdateParser调用该接口更新解析器名称和描述查看文档去调试
UpdateParserDataSource更新解析器的数据源查看文档去调试
UpdateDestination调用该接口更新数据目的名称、操作类型和描述信息查看文档去调试
DeleteParser调用该接口删除解析器查看文档去调试
DeleteParserDataSource调用该接口删除已创建的数据源查看文档去调试
DeleteDataSourceItem调用该接口删除指定数据源下的指定Topic查看文档去调试
DeleteDestination调用该接口删除已创建的数据目的查看文档去调试
DetachParserDataSource调用该接口删除解析器中的指定数据源查看文档去调试
DetachDestination删除解析器的指定数据目的查看文档去调试
StopParser调用该接口停止解析器运行查看文档去调试
数据服务
OpenAPI 名称描述操作
WriteDevicesHotStorageData调用该接口将设备自定义Topic数据写入热数据存储空间查看文档去调试
CreateDataAPIServicehot调用该接口创建数据算法服务API查看文档去调试
AddDataForApiSource调用该接口向物联网平台导入外部数据。通过此API导入物联网平台的数据,称为API数据源的数据。您可将本地或其他平台的数据上传至物联网平台,用于数据的分析和处理查看文档去调试
BatchAddDataForApiSource调用该接口向物联网平台批量导入外部数据。通过此API导入物联网平台的数据,称为API数据源的数据。您可将本地或其他平台的数据批量上传至物联网平台,用于数据的分析和处理查看文档去调试
CreateDownloadDataJob调用接口创建数据下载任务查看文档去调试
ListAnalyticsData调用该接口执行数据服务API对应的查询任务,从而获取数据源里的指定数据查看文档去调试
QueryDevicesHotStorageDataStatus调用该接口查询设备热数据的快照数据查看文档去调试
QueryDevicesHotStorageData调用该接口查询设备热数据的时序数据查看文档去调试
GetDataAPIServiceDetail调用该接口获取数据算法服务API详情查看文档去调试
InvokeDataAPIService调用该接口调用数据算法服务API,获取SQL查询结果查看文档去调试
GetDownloadFile调用该接口获取数据表数据下载任务的执行结果查看文档去调试
ResetDeviceTimeline调用该接口删除指定设备下已存储的时序数据查看文档去调试
消息通信
OpenAPI 名称描述操作
BatchPub通过自定义Topic,向指定产品下的多个设备,批量发送消息查看文档去调试
Pubhot调用该接口通过自定义Topic向设备发布消息,支持向指定产品下订阅了指定自定义Topic的在线设备发送广播消息查看文档去调试
PubBroadcast向指定产品所有设备,或向订阅了指定Topic的所有设备发布广播消息查看文档去调试
RRpchot向指定设备发送请求消息,并同步返回响应查看文档去调试
AsyncRRpc调用该接口向指定设备发送消息查看文档去调试
SubscribeTopic该接口为指定设备订阅Topic查看文档去调试
QueryMessageInfo查询设备上下行消息的详情,包括消息的内容、消息的产生时间、发送消息的Topic等查看文档去调试
QueryDeviceSubTopic调用该接口查询设备已订阅的Topic列表查看文档去调试
UpdateTopicConfig调用该接口设置自定义Topic是否支持保留消息广播查看文档去调试
服务端订阅
OpenAPI 名称描述操作
CreateSubscribeRelation调用该接口创建MNS或AMQP服务端订阅查看文档去调试
CreateConsumerGroup调用该接口创建一个消费组,用于创建AMQP服务端订阅查看文档去调试
CreateConsumerGroupSubscribeRelation调用该接口在AMQP订阅中添加一个消费组查看文档去调试
QuerySubscribeRelation调用该接口查询MNS或AMQP服务端订阅查看文档去调试
QueryConsumerGroupByGroupId调用该接口查询AMQP服务端订阅的消费组详情查看文档去调试
QueryConsumerGroupList查询用户所有消费组列表,或按消费组名称进行模糊查询查看文档去调试
QueryConsumerGroupStatus查询某个消费组的状态,包括在线客户端信息、消息消费速率、消息堆积数、最近消息消费时间查看文档去调试
UpdateSubscribeRelation调用该接口修改MNS或AMQP服务端订阅查看文档去调试
UpdateConsumerGroup使用AMQP服务端订阅时,可以调用该接口修改消费组名称查看文档去调试
DeleteSubscribeRelation调用该接口删除MNS或AMQP服务端订阅查看文档去调试
ResetConsumerGroupPosition使用AMQP服务端订阅时,调用该接口清空某个消费组的堆积消息查看文档去调试
DeleteConsumerGroup使用AMQP服务端订阅时,可以调用该接口删除消费组查看文档去调试
DeleteConsumerGroupSubscribeRelation从AMQP订阅中的多个消费组移除指定消费组查看文档去调试
设备影子
OpenAPI 名称描述操作
GetDeviceShadow调用该接口查询指定设备的影子信息查看文档去调试
UpdateDeviceShadow调用该接口修改指定设备的影子信息查看文档去调试
OTA升级
OpenAPI 名称描述操作
GenerateOTAUploadURL生成升级包文件上传到OSS的URL及详细信息查看文档去调试
GenerateDeviceNameListURL生成设备列表文件上传到OSS的URL及详细信息查看文档去调试
CreateOTAFirmware生成OTA升级包文件的URL后,调用该接口创建设备的OTA升级包查看文档去调试
CreateOTAVerifyJob调用该接口创建OTA升级包验证任务查看文档去调试
CreateOTAStaticUpgradeJob调用该接口创建静态升级批次查看文档去调试
CreateOTADynamicUpgradeJob调用该接口创建动态升级批次查看文档去调试
CreateOTAModule调用该接口创建产品的OTA模块查看文档去调试
ConfirmOTATask批量确认,处于待确认状态的设备升级作业查看文档去调试
ReupgradeOTATask调用该接口重新升级指定批次下升级失败或升级取消的设备升级作业查看文档去调试
ListOTAFirmware调用该接口查询OTA升级包列表查看文档去调试
QueryOTAFirmware调用该接口查询指定OTA升级包的详细信息,包括升级包的名称、类型、状态等查看文档去调试
ListOTAJobByFirmware调用该接口获取升级包下的升级任务批次列表查看文档去调试
ListOTAJobByDevice调用该接口获取设备所在的升级包升级批次列表查看文档去调试
ListOTATaskByJob调用该接口查询指定升级批次下的设备升级作业列表查看文档去调试
QueryOTAJob调用该接口查询指定升级批次的详情查看文档去调试
ListOTAModuleByProduct调用该接口查询产品下的OTA模块列表查看文档去调试
ListOTAUnfinishedTaskByDevice查询指定设备下,未完成状态的设备升级作业查看文档去调试
ListOTAModuleVersionsByDevice调用该接口查询设备上报过的OTA模块版本列表查看文档去调试
ModifyOTAFirmware调用该接口修改升级包信息,包括升级包名称、升级包描述和自定义信息查看文档去调试
CancelOTATaskByJob调用该接口取消指定批次下的设备升级作业查看文档去调试
CancelOTATaskByDevice取消指定固件下状态为待升级的设备升级作业查看文档去调试
UpdateOTAModule调用该接口修改OTA模块别名、描述查看文档去调试
DeleteOTAFirmware调用该接口删除指定OTA升级包查看文档去调试
CancelOTAStrategyByJob调用该接口取消动态升级策略查看文档去调试
DeleteOTAModule调用该接口删除自定义OTA模块查看文档去调试
开通服务
OpenAPI 名称描述操作
OpenIotService调用该接口开通物联网平台服务查看文档去调试
增值服务
OpenAPI 名称描述操作
音视频通信服务
BindLicenseProduct调用该接口为指定产品授权License查看文档去调试
BindLicenseDevice调用该接口为指定产品下设备授权License查看文档去调试
ReBindLicenseDevice调用该接口为指定产品下设备重新授权License查看文档去调试
CheckBindLicenseDeviceProgress调用该接口根据批量授权设备接口返回的唯一ID(CheckProgressId)查询授权的进度查看文档去调试
QueryLicenseDeviceList调用该接口查询授权License的设备列表查看文档去调试
UnbindLicenseProduct调用该接口取消指定产品的License授权查看文档去调试
IoT孪生引擎
ImportDTData调用该接口触发孪生体的数据映射配置,实现数据到孪生节点的映射查看文档去调试
寄雁传书服务
PrintByTemplate调用该接口根据寄雁传书服务控制台创建的小票打印模板完成小票打印查看文档去调试
位置服务
GisQueryDeviceLocation调用该接口查询设备位置信息查看文档去调试
GisSearchDeviceTrace调用该接口查询设备轨迹详情查看文档去调试
千里传音
CreateSpeech调用该接口创建语料查看文档去调试
PushSpeech将语料推送到设备查看文档去调试
SpeechByCombination调用该接口推送音频到设备播报查看文档去调试
SyncSpeechByCombination调用该接口同步组合播报设备中的语料查看文档去调试
SpeechBySynthesis调用该接口下发动态播报内容到设备进行播报查看文档去调试
AddShareTaskDevice调用该接口添加设备到分享任务查看文档去调试
ShareSpeechByCombination调用该接口推送共享音频到设备播报查看文档去调试
QuerySpeechLicenseAvailableQuota调用该接口查询当前License的剩余可用配额查看文档去调试
GetSpeechVoice获取语料播报的声音配置查看文档去调试
TestSpeech调用该接口试听语料查看文档去调试
QuerySpeech调用该接口查询语料详情,包括语料的播报声音、语料类型和音量大小等查看文档去调试
QuerySpeechList查询指定项目语料列表查看文档去调试
QuerySolutionDeviceGroupPage查询指定项目下的分组列表查看文档去调试
QuerySpeechPushJob查询指定项目的语料推送任务列表查看文档去调试
QuerySpeechPushJobDevice查询指定语料推送任务下的设备 查看文档去调试
QuerySpeechPushJobSpeech查询语料推送任务下的语料详情,包括语料的播报声音、语料类型和语料文本等查看文档去调试
QuerySpeechDevice查询播报设备的列表查看文档去调试
QueryDeviceSpeech查询指定设备的语料列表查看文档去调试
GetSpeechDeviceDetail查询播报设备的详情,包括设备的状态、设备的可用空间等查看文档去调试
GetShareTaskByDeviceOpen调用该接口根据设备信息查询分享任务查看文档去调试
GetShareSpeechModelAudio调用该接口获取共享语料的语音文件查看文档去调试
GetSpeechLicenseDeviceStatistics调用该接口查询千里传音License设备统计查看文档去调试
QuerySpeechLicenseDeviceList调用该接口查询千里传音License设备列表查看文档去调试
QueryProjectShareDeviceList调用该接口查询项目的分享设备列表查看文档去调试
QueryShareTaskDeviceList调用该接口查询分享任务的设备列表查看文档去调试
PageQuerySharedSpeechOpen被共享方调用该接口分页查询共享的语料查看文档去调试
CountSpeechBroadcastHour调用该接口分页查询千里传音中共享播报的小时数据量查看文档去调试
PageQuerySpeechBroadcastHour调用该接口分页查询千里传音中共享播报的小时数据查看文档去调试
UpdateSpeech更新语料,包括语料的播报声音、播报速度和音量大小等查看文档去调试
DeleteSpeech删除指定语料查看文档去调试
DeleteDeviceSpeech调用该接口删除设备中的语料查看文档去调试
DeleteShareTaskDevice调用该接口删除分享任务设备查看文档去调试
CreateSharePromotionActivity调用该接口创建千里传音分享任务的促销活动查看文档去调试
QuerySharePromotionActivityAuditResult调用该接口查询千里传音分享任务的促销活动审核结果查看文档去调试
AddDeviceToSharePromotion调用该接口将千里传音分享任务中已有共享设备添加到促销活动中查看文档去调试
CreateSharePromotionSpeechModel调用该接口为千里传音分享任务的促销活动创建共享语料查看文档去调试
QueryShareProductNameByProductKey调用该接口根据产品ProductKey查询分享任务中共享设备所属产品的名称查看文档去调试
声码服务
CreateSoundCode调用该接口创建声码查看文档去调试
CreateSoundCodeSchedule调用该接口创建声码排程查看文档去调试
CreateSchedulePeriod调用该接口创建声码排程时间段查看文档去调试
CreateSoundCodeLabel调用该接口为指定排程创建声码标签查看文档去调试
BatchCreateSoundCodeLabel调用该接口为指定排程批量创建声码标签查看文档去调试
BatchCreateSoundCodeLabelWithLabels调用该接口为指定排程批量创建指定声码标签查看文档去调试
QuerySoundCodeList调用该接口查询声码列表查看文档去调试
GetSoundCodeAudio调用该接口获取声码音频下载地址查看文档去调试
QuerySoundCodeScheduleList调用该接口查询声码排程列表查看文档去调试
GetSoundCodeSchedule调用该接口查询声码排程详情查看文档去调试
QuerySchedulePeriodList调用该接口查询声码排程时间段列表查看文档去调试
QuerySoundCodeLabelList调用该接口查询指定排程的声码标签列表查看文档去调试
QuerySoundCodeLabelBatchList调用该接口查询指定排程的声码标签批次列表查看文档去调试
QuerySoundCodeLabelBatchFailedResult调用该接口查询指定声码标签批次下创建失败的声码标签列表查看文档去调试
PackageSoundCodeLabelBatchAudio调用该接口获取声码标签批次音频打包地址查看文档去调试
UpdateSoundCodeSchedule调用该接口更新声码排程查看文档去调试
UpdateSchedulePeriod调用该接口更新声码排程时间段查看文档去调试
UpdateSoundCodeLabel调用该接口更新声码标签查看文档去调试
RetrySoundCodeLabelBatch调用该接口重启声码标签批次查看文档去调试
UpdateSoundCode调用该接口更新声码查看文档去调试
DeleteSoundCode调用该接口删除声码查看文档去调试
DeleteSoundCodeSchedule调用该接口删除声码排程查看文档去调试
DeleteSchedulePeriod调用该接口删除声码排程时间段查看文档去调试
DeleteSoundCodeLabel调用该接口删除声码标签查看文档去调试
场景联动
OpenAPI 名称描述操作
CreateSceneRule创建场景联动规则 查看文档去调试
GetSceneRule获取场景联动规则详情 查看文档去调试
QuerySceneRule调用该接口查询场景联动规则列表查看文档去调试
QuerySummarySceneRuleLog调用该接口查询场景联动规则日志查看文档去调试
QueryDetailSceneRuleLog查看场景联动规则日志的详细信息 查看文档去调试
UpdateSceneRule更新场景联动规则 查看文档去调试
EnableSceneRule启动场景联动规则 查看文档去调试
DisableSceneRule停止场景联动规则 查看文档去调试
TriggerSceneRule调用该接口触发场景联动规则查看文档去调试
DeleteSceneRule删除场景联动规则查看文档去调试
边缘实例管理
OpenAPI 名称描述操作
CreateEdgeInstance创建边缘实例查看文档去调试
BindGatewayToEdgeInstance将网关分配到边缘实例中 查看文档去调试
BindDriverToEdgeInstance将驱动分配到边缘实例中查看文档去调试
BatchBindDeviceToEdgeInstanceWithDriver批量将设备分配到边缘实例中,并为设备设置驱动查看文档去调试
CreateEdgeInstanceDeployment部署边缘实例,创建边缘实例部署单查看文档去调试
GetEdgeInstance获取边缘实例详情查看文档去调试
QueryEdgeInstance查询当前账号下的所有边缘实例 查看文档去调试
QueryEdgeInstanceGateway查询边缘实例中的网关查看文档去调试
QueryEdgeInstanceDriver查询边缘实例的驱动列表 查看文档去调试
BatchGetEdgeInstanceDriverConfigs批量获取边缘实例驱动配置查看文档去调试
QueryEdgeInstanceDevice查询边缘实例中的设备列表查看文档去调试
BatchGetEdgeInstanceDeviceConfig批量获取边缘实例设备配置查看文档去调试
GetEdgeInstanceDeployment获取边缘实例部署详情 查看文档去调试
QueryEdgeInstanceHistoricDeployment查询边缘实例历史部署记录 查看文档去调试
UpdateEdgeInstance更新边缘实例查看文档去调试
SetEdgeInstanceDriverConfigs调用该接口配置边缘实例驱动查看文档去调试
BatchSetEdgeInstanceDeviceConfig调用该接口批量配置边缘实例设备查看文档去调试
DeleteEdgeInstance删除边缘实例查看文档去调试
UnbindDriverFromEdgeInstance调用该接口将驱动从边缘实例中移除查看文档去调试
ClearEdgeInstanceDriverConfigs清空边缘实例驱动配置查看文档去调试
BatchUnbindDeviceFromEdgeInstance批量将设备从边缘实例中移除查看文档去调试
BatchClearEdgeInstanceDeviceConfig批量清空边缘实例设备配置查看文档去调试
CloseEdgeInstanceDeployment关闭边缘实例部署任务单查看文档去调试
边缘计算新增API
OpenAPI 名称描述操作
CreateEdgeDriver创建驱动 查看文档去调试
CreateEdgeDriverVersion新增驱动版本查看文档去调试
CreateEdgeOssPreSignedAddress创建对象存储 OSS 预签名地址查看文档去调试
BindApplicationToEdgeInstance绑定边缘应用到边缘实例查看文档去调试
CreateEdgeInstanceChannel调用该接口创建边缘实例中的驱动通道查看文档去调试
BatchSetEdgeInstanceDeviceChannel批量关联驱动通道到子设备查看文档去调试
ReleaseEdgeDriverVersion发布驱动的某一版本查看文档去调试
BindRoleToEdgeInstance将角色绑定到边缘实例查看文档去调试
BatchGetEdgeDriver批量查询驱动信息查看文档去调试
QueryEdgeDriver调用该接口分页查询驱动信息查看文档去调试
GetEdgeDriverVersion查询驱动某一版本的信息查看文档去调试
QueryEdgeDriverVersion分页查询驱动版本列表查看文档去调试
BatchGetEdgeInstanceChannel批量查询边缘实例中的驱动通道查看文档去调试
QueryEdgeInstanceChannel查询边缘实例中的驱动通道列表 查看文档去调试
BatchGetEdgeInstanceDeviceChannel批量获取子设备关联的驱动通道查看文档去调试
QueryEdgeInstanceDeviceByDriver查询驱动下关联的子设备 查看文档去调试
BatchGetEdgeInstanceDeviceDriver批量获取子设备关联的驱动查看文档去调试
BatchGetDeviceBindStatus调用该接口批量获取网关或设备绑定到边缘实例的状态查看文档去调试
UpdateEdgeDriverVersion调用该接口更新驱动版本查看文档去调试
UpdateEdgeInstanceChannel调用该接口更新边缘实例中的驱动通道查看文档去调试
ReplaceEdgeInstanceGateway替换已绑定到边缘实例的网关。替换网关后,原网关的部署状态和部署历史会被清除查看文档去调试
DeleteEdgeDriver删除已创建的驱动 查看文档去调试
DeleteEdgeDriverVersion删除驱动的某一版本查看文档去调试
UnbindApplicationFromEdgeInstance从边缘实例中移除边缘应用查看文档去调试
BatchDeleteEdgeInstanceChannel批量删除边缘实例中驱动的通道查看文档去调试
UnbindRoleFromEdgeInstance调用该接口解除边缘实例中已绑定的角色查看文档去调试
边缘计算-场景联动
OpenAPI 名称描述操作
BindSceneRuleToEdgeInstance绑定场景联动规则到边缘实例 查看文档去调试
QueryEdgeInstanceSceneRule分页查询边缘实例中的场景规则查看文档去调试
UnbindSceneRuleFromEdgeInstance调用该接口,从边缘实例中移除场景联动规则查看文档去调试
边缘计算-远程运维
OpenAPI 名称描述操作
EnableDeviceTunnel调用该接口开启设备隧道查看文档去调试
EnableDeviceTunnelShare调用该接口开启网关隧道分享查看文档去调试
GetDeviceTunnelStatus调用该接口查询网关设备的隧道状态查看文档去调试
GetDeviceTunnelShareStatus调用该接口获取网关隧道的分享状态查看文档去调试
RefreshDeviceTunnelSharePassword调用该接口更新网关隧道分享密码查看文档去调试
DisableDeviceTunnel调用该接口关闭网关隧道查看文档去调试
DisableDeviceTunnelShare调用该接口关闭网关隧道分享查看文档去调试
边缘计算-消息路由
OpenAPI 名称描述操作
CreateEdgeInstanceMessageRouting调用该接口,为指定的边缘实例创建消息路由查看文档去调试
GetEdgeInstanceMessageRouting调用该接口,获取边缘实例中消息路由的详细信息查看文档去调试
QueryEdgeInstanceMessageRouting分页查询边缘实例中的消息路由查看文档去调试
UpdateEdgeInstanceMessageRouting调用该接口更新边缘实例中的消息路由查看文档去调试
DeleteEdgeInstanceMessageRouting调用该接口删除边缘实例中的消息路由查看文档去调试
物联网应用开发API管理
OpenAPI 名称描述操作
BatchBindProductsIntoProject批量关联产品到项目中查看文档去调试
BatchBindDevicesIntoProject调用该接口批量关联设备到项目中查看文档去调试
SetStudioProjectCooperation调用该接口设置项目协作,即阿里云账号可以给不同的RAM用户授权不同的项目查看文档去调试
CreateStudioAppDomainOpen调用该接口为应用添加域名查看文档去调试
SetupStudioAppAuthModeOpen调用该接口设置应用鉴权模式查看文档去调试
PublishStudioApp调用该接口发布应用查看文档去调试
QueryStudioProjectList调用该接口获取项目列表查看文档去调试
QueryStudioAppList调用该接口获取应用列表查看文档去调试
QueryStudioAppPageListOpen调用该接口获取应用页面列表查看文档去调试
QueryStudioAppDomainListOpen调用该接口获取应用绑定域名列表查看文档去调试
GetStudioAppTokenOpen调用该接口查询应用鉴权Token查看文档去调试
BatchUnbindProjectDevices调用该接口批量解除项目中关联的设备查看文档去调试
RefreshStudioAppTokenOpen调用该接口刷新应用鉴权Token查看文档去调试
BatchUnbindProjectProducts解绑指定项目下的指定产品。支持批量查看文档去调试
DeleteStudioAppDomainOpen调用该接口删除应该绑定的域名查看文档去调试
其他
OpenAPI 名称描述操作
TestSwitch查看文档去调试
CreateTopicConfig查看文档去调试
DeleteTopicConfig查看文档去调试
QueryTopicConfig查看文档去调试
其它
OpenAPI 名称描述操作
DeleteUserDefineTableDataByPrimaryKey查看文档去调试
AddPowerStation查看文档去调试
DeletePowerStation查看文档去调试
ListPowerStation查看文档去调试
ModifyPowerStation查看文档去调试
StartPTDetection查看文档去调试
UpdateOTAJob查看文档去调试
QueryCustomTimelineTableStatus查看文档去调试
CopyThingModelAsync查看文档去调试
GetThingModelStatusInner查看文档去调试
PublishThingModelAsync查看文档去调试
PublishThingModelAsyncInner查看文档去调试
UnsubscribeTopic查看文档去调试