产品管理
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
CreateProduct![]() | 调用该接口创建产品 | 查看文档去调试 |
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 | 一型一密免注册场景下,调用该接口查看单个设备的标识列表 | 查看文档去调试 |
QueryDeviceInfo![]() | 查询指定设备的基本信息(设备ID、设备证书和备注名称) | 查看文档去调试 |
QueryDeviceDetail![]() | 调用该接口查询指定设备的详细信息 | 查看文档去调试 |
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个),可调用该接口删除设备下的所有标识 | 查看文档去调试 |
DeleteDevice | Deletes 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 名称 | 描述 | 操作 |
---|---|---|
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 | 调用该接口批量调用设备服务 | 查看文档去调试 |
QueryDevicePropertyData![]() | 调用该接口查询指定设备或数字孪生节点,在指定时间段内,单个属性的数据 | 查看文档去调试 |
QueryDevicePropertiesData | 调用该接口查询指定设备或数字孪生节点,在指定时间段内,多个属性的数据 | 查看文档去调试 |
QueryDeviceEventData | 调用该接口查询指定设备的事件记录 | 查看文档去调试 |
QueryDeviceServiceData | 调用该接口查询指定设备的服务调用记录 | 查看文档去调试 |
QueryDeviceDesiredProperty | 调用该接口查询指定设备的期望属性值 | 查看文档去调试 |
QueryDevicePropertyStatus![]() | 调用该接口查询指定设备或数字孪生节点的所有属性快照 | 查看文档去调试 |
QueryDeviceOriginalPropertyStatus | 查询指定设备本身上报的原始属性(通过和未通过物模型校验的所有属性)快照 | 查看文档去调试 |
QueryDeviceOriginalPropertyData | 调用该接口查询指定设备本身上报的原始属性(通过和未通过物模型校验的所有属性)记录 | 查看文档去调试 |
QueryDeviceOriginalEventData | 查询指定设备本身上报的原始事件(通过和未通过物模型校验的所有事件)记录 | 查看文档去调试 |
QueryDeviceOriginalServiceData | 查询指定设备本身调用的原始服务(通过和未通过物模型校验的所有服务)记录 | 查看文档去调试 |
SetDeviceProperty![]() | 调用该接口为指定设备设置属性值 | 查看文档去调试 |
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数据写入热数据存储空间 | 查看文档去调试 |
CreateDataAPIService![]() | 调用该接口创建数据算法服务API | 查看文档去调试 |
AddDataForApiSource | 调用该接口向物联网平台导入外部数据。通过此API导入物联网平台的数据,称为API数据源的数据。您可将本地或其他平台的数据上传至物联网平台,用于数据的分析和处理 | 查看文档去调试 |
BatchAddDataForApiSource | 调用该接口向物联网平台批量导入外部数据。通过此API导入物联网平台的数据,称为API数据源的数据。您可将本地或其他平台的数据批量上传至物联网平台,用于数据的分析和处理 | 查看文档去调试 |
CreateDownloadDataJob | 调用接口创建数据下载任务 | 查看文档去调试 |
ListAnalyticsData | 调用该接口执行数据服务API对应的查询任务,从而获取数据源里的指定数据 | 查看文档去调试 |
QueryDevicesHotStorageDataStatus | 调用该接口查询设备热数据的快照数据 | 查看文档去调试 |
QueryDevicesHotStorageData | 调用该接口查询设备热数据的时序数据 | 查看文档去调试 |
GetDataAPIServiceDetail | 调用该接口获取数据算法服务API详情 | 查看文档去调试 |
InvokeDataAPIService | 调用该接口调用数据算法服务API,获取SQL查询结果 | 查看文档去调试 |
GetDownloadFile | 调用该接口获取数据表数据下载任务的执行结果 | 查看文档去调试 |
ResetDeviceTimeline | 调用该接口删除指定设备下已存储的时序数据 | 查看文档去调试 |
消息通信
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
BatchPub | 通过自定义Topic,向指定产品下的多个设备,批量发送消息 | 查看文档去调试 |
Pub![]() | 调用该接口通过自定义Topic向设备发布消息,支持向指定产品下订阅了指定自定义Topic的在线设备发送广播消息 | 查看文档去调试 |
PubBroadcast | 向指定产品所有设备,或向订阅了指定Topic的所有设备发布广播消息 | 查看文档去调试 |
RRpc![]() | 向指定设备发送请求消息,并同步返回响应 | 查看文档去调试 |
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订阅中的多个消费组移除指定消费组 | 查看文档去调试 |
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 名称 | 描述 | 操作 |
---|---|---|
音视频通信服务 | ||
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 名称 | 描述 | 操作 |
---|---|---|
EnableDeviceTunnel | 调用该接口开启设备隧道 | 查看文档去调试 |
EnableDeviceTunnelShare | 调用该接口开启网关隧道分享 | 查看文档去调试 |
GetDeviceTunnelStatus | 调用该接口查询网关设备的隧道状态 | 查看文档去调试 |
GetDeviceTunnelShareStatus | 调用该接口获取网关隧道的分享状态 | 查看文档去调试 |
RefreshDeviceTunnelSharePassword | 调用该接口更新网关隧道分享密码 | 查看文档去调试 |
DisableDeviceTunnel | 调用该接口关闭网关隧道 | 查看文档去调试 |
DisableDeviceTunnelShare | 调用该接口关闭网关隧道分享 | 查看文档去调试 |
边缘计算-消息路由
物联网应用开发API管理
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
BatchBindProductsIntoProject | 批量关联产品到项目中 | 查看文档去调试 |
BatchBindDevicesIntoProject | 调用该接口批量关联设备到项目中 | 查看文档去调试 |
SetStudioProjectCooperation | 调用该接口设置项目协作,即阿里云账号可以给不同的RAM用户授权不同的项目 | 查看文档去调试 |
CreateStudioAppDomainOpen | 调用该接口为应用添加域名 | 查看文档去调试 |
SetupStudioAppAuthModeOpen | 调用该接口设置应用鉴权模式 | 查看文档去调试 |
PublishStudioApp | 调用该接口发布应用 | 查看文档去调试 |
QueryStudioProjectList | 调用该接口获取项目列表 | 查看文档去调试 |
QueryStudioAppList | 调用该接口获取应用列表 | 查看文档去调试 |
QueryStudioAppPageListOpen | 调用该接口获取应用页面列表 | 查看文档去调试 |
QueryStudioAppDomainListOpen | 调用该接口获取应用绑定域名列表 | 查看文档去调试 |
GetStudioAppTokenOpen | 调用该接口查询应用鉴权Token | 查看文档去调试 |
BatchUnbindProjectDevices | 调用该接口批量解除项目中关联的设备 | 查看文档去调试 |
RefreshStudioAppTokenOpen | 调用该接口刷新应用鉴权Token | 查看文档去调试 |
BatchUnbindProjectProducts | 解绑指定项目下的指定产品。支持批量 | 查看文档去调试 |
DeleteStudioAppDomainOpen | 调用该接口删除应该绑定的域名 | 查看文档去调试 |
其它
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
DeleteUserDefineTableDataByPrimaryKey | 查看文档去调试 | |
AddPowerStation | 查看文档去调试 | |
DeletePowerStation | 查看文档去调试 | |
ListPowerStation | 查看文档去调试 | |
ModifyPowerStation | 查看文档去调试 | |
StartPTDetection | 查看文档去调试 | |
UpdateOTAJob | 查看文档去调试 | |
QueryCustomTimelineTableStatus | 查看文档去调试 | |
CopyThingModelAsync | 查看文档去调试 | |
GetThingModelStatusInner | 查看文档去调试 | |
PublishThingModelAsync | 查看文档去调试 | |
PublishThingModelAsyncInner | 查看文档去调试 | |
UnsubscribeTopic | 查看文档去调试 |