文档首页/ 设备接入 IoTDA/ CLI参考/ CLI命令参考(IoTDA)
更新时间:2026-10-14 GMT+08:00
分享

CLI命令参考(IoTDA)

产品管理

API名称

命令

描述

操作

查询产品列表

hcloud IoTDA ListProducts

应用服务器可调用此接口查询已导入物联网平台的产品模型信息列表,了解产品模型的概要信息。

去调试

创建产品

hcloud IoTDA CreateProduct

应用服务器可调用此接口创建产品。此接口仅创建了产品,没有创建和安装插件,如果需要对数据进行编解码,还需要在平台开发和安装插件。

去调试

查询产品

hcloud IoTDA ShowProduct

应用服务器可调用此接口查询已导入物联网平台的指定产品模型详细信息,包括产品模型的服务、属性、命令等。

去调试

修改产品

hcloud IoTDA UpdateProduct

应用服务器可调用此接口修改已导入物联网平台的指定产品模型,包括产品模型的服务、属性、命令等。此接口仅修改了产品,未修改和安装插件,如果修改了产品中的service定义,且在平台中有对应的插件,请修改并重新安装插件。

去调试

删除产品

hcloud IoTDA DeleteProduct

应用服务器可调用此接口删除已导入物联网平台的指定产品模型。此接口仅删除了产品,未删除关联的插件,在产品下存在设备时,该产品不允许删除。

去调试

设备管理

API名称

命令

描述

操作

查询设备列表

hcloud IoTDA ListDevices

应用服务器可调用此接口查询物联网平台中的设备信息列表。

去调试

创建设备

hcloud IoTDA AddDevice

应用服务器可调用此接口在物联网平台创建一个设备,仅在创建后设备才可以接入物联网平台。

去调试

查询设备

hcloud IoTDA ShowDevice

应用服务器可调用此接口查询物联网平台中指定设备的详细信息。

去调试

修改设备

hcloud IoTDA UpdateDevice

应用服务器可调用此接口修改物联网平台中指定设备的基本信息。

去调试

删除设备

hcloud IoTDA DeleteDevice

应用服务器可调用此接口在物联网平台上删除指定设备。若设备下连接了非直连设备,则必须把设备下的非直连设备都删除后,才能删除该设备。该接口仅支持删除单个设备,如需批量删除设备,请参见 创建批量任务。

去调试

重置设备密钥

hcloud IoTDA ResetDeviceSecret

应用服务器可调用此接口重置设备密钥,携带指定密钥时平台将设备密钥重置为指定的密钥,不携带密钥时平台将自动生成一个新的随机密钥返回。

去调试

冻结设备

hcloud IoTDA FreezeDevice

应用服务器可调用此接口冻结设备,设备冻结后不能再连接上线,可以通过解冻设备接口解除设备冻结。注意,当前仅支持冻结与平台直连的设备。该接口仅支持冻结单个设备,如需批量冻结设备,请参见 创建批量任务。

去调试

解冻设备

hcloud IoTDA UnfreezeDevice

应用服务器可调用此接口解冻设备,解除冻结后,设备可以连接上线。该接口仅支持解冻单个设备,如需批量解冻设备,请参见 创建批量任务。

去调试

重置设备指纹

hcloud IoTDA ResetFingerprint

应用服务器可调用此接口重置设备指纹。携带指定设备指纹时将之重置为指定值;不携带时将之置空,后续设备第一次接入时,该设备指纹的值将设置为第一次接入时的证书指纹。

去调试

修改设备网关

hcloud IoTDA ChangeGateway

应用服务器可调用此接口在物联网平台修改子设备网关。

去调试

灵活搜索设备列表

hcloud IoTDA SearchDevices

应用服务器使用SQL语句调用该接口,灵活的搜索所需要的设备资源列表。

去调试

查询指定设备加入的设备组列表

hcloud IoTDA ListDeviceGroupsByDevice

应用服务器可调用此接口查询物联网平台中的某个设备加入的设备组信息列表。仅标准版实例、企业版实例支持该接口调用,基础版不支持。

去调试

设备消息

API名称

命令

描述

操作

查询设备消息

hcloud IoTDA ListDeviceMessages

应用服务器可调用此接口查询平台下发给设备的消息,平台为每个设备默认最多保存20条消息,超过20条后, 后续的消息会替换下发最早的消息。

去调试

下发设备消息

hcloud IoTDA CreateMessage

物联网平台可向设备下发消息,应用服务器可调用此接口向指定设备下发消息,以实现对设备的控制。应用将消息下发给平台后,平台返回应用响应结果,平台再将消息发送给设备。平台返回应用响应结果不一定是设备接收结果,建议用户应用通过订阅设备消息状态变更通知,订阅后平台会将设备接收结果推送给订阅的应用。

去调试

查询指定消息id的消息

hcloud IoTDA ShowDeviceMessage

应用服务器可调用此接口查询平台下发给设备的指定消息id的消息。

去调试

删除指定消息id的消息

hcloud IoTDA DeleteDeviceMessage

应用服务器可调用此接口删除平台下发给设备的指定消息id的消息。

去调试

设备命令

API名称

命令

描述

操作

下发设备命令

hcloud IoTDA CreateCommand

设备的产品模型中定义了物联网平台可向设备下发的命令,应用服务器可调用此接口向指定设备下发命令,以实现对设备的同步控制。平台负责将命令以同步方式发送给设备,并将设备执行命令结果同步返回, 如果设备没有响应,平台会返回给应用服务器超时,平台超时时间是20秒。如果命令下发需要超过20秒,建议采用消息下发。

去调试

设备异步命令

API名称

命令

描述

操作

下发异步设备命令

hcloud IoTDA CreateAsyncCommand

设备的产品模型中定义了物联网平台可向设备下发的命令,应用服务器可调用此接口向指定设备下发异步命令,以实现对设备的控制。平台负责将命令发送给设备,并将设备执行命令结果异步通知应用服务器。 命令执行结果支持灵活的数据流转,应用服务器通过调用物联网平台的创建规则触发条件(Resource:device.command.status,Event:update)、创建规则动作并激活规则后,当命令状态变更时,物联网平台会根据规则将结果发送到规则指定的服务器,如用户自定义的HTTP服务器,AMQP服务器,以及华为云的其他储存服务器等, 详情参考设备命令状态变更通知。

去调试

查询设备下队列中的命令

hcloud IoTDA ListAsyncCommands

查询设备下队列中的命令(处理中的命令),包含PENDING、SENT、DELIVERED三种状态,注意:DELIVERED状态的命令经过系统设定的一段时间(具体以系统配置为准)仍然没有更新,就会从队列中移除,变为历史命令。

去调试

查询设备下的历史命令

hcloud IoTDA ListAsyncHistoryCommands

查询设备下发的历史异步命令,包含EXPIRED、SUCCESSFUL、FAILED、TIMEOUT、DELIVERED五种状态。

去调试

统计设备下的历史命令总数

hcloud IoTDA CountAsyncHistoryCommands

统计设备下的历史命令总数。

去调试

查询指定id的命令

hcloud IoTDA ShowAsyncDeviceCommand

物联网平台可查询指定id的命令。

去调试

设备属性

API名称

命令

描述

操作

查询设备属性

hcloud IoTDA ListProperties

设备的产品模型中定义了物联网平台可向设备下发的属性,应用服务器可调用此接口向设备发送指令用以查询设备的实时属性, 并由设备将属性查询的结果同步返回给应用服务器。

去调试

修改设备属性

hcloud IoTDA UpdateProperties

设备的产品模型中定义了物联网平台可向设备下发的属性,应用服务器可调用此接口向指定设备下发属性。平台负责将属性以同步方式发送给设备,并将设备执行属性结果同步返回。

去调试

AMQP队列管理

API名称

命令

描述

操作

查询AMQP列表

hcloud IoTDA BatchShowQueue

应用服务器可调用此接口查询物联网平台中的AMQP队列信息列表。可通过队列名称作模糊查询,支持分页。

去调试

创建AMQP队列

hcloud IoTDA AddQueue

应用服务器可调用此接口在物联网平台创建一个AMQP队列。每个租户只能创建100个队列,若超过规格,则创建失败,若队列名称与已有的队列名称相同,则创建失败。

去调试

查询单个AMQP队列

hcloud IoTDA ShowQueue

应用服务器可调用此接口查询物联网平台中指定队列的详细信息。

去调试

删除AMQP队列

hcloud IoTDA DeleteQueue

应用服务器可调用此接口在物联网平台上删除指定AMQP队列。若当前队列正在使用,则会删除失败。

去调试

接入凭证管理

API名称

命令

描述

操作

生成接入凭证

hcloud IoTDA CreateAccessCode

接入凭证是用于客户端使用AMQP等协议与平台建链的一个认证凭据。只保留一条记录,如果重复调用只会重置接入凭证,使得之前的失效。

去调试

数据流转规则管理

API名称

命令

描述

操作

查询规则条件列表

hcloud IoTDA ListRoutingRules

应用服务器可调用此接口查询物联网平台中设置的规则条件列表。

去调试

创建规则触发条件

hcloud IoTDA CreateRoutingRule

应用服务器可调用此接口在物联网平台创建一条规则触发条件。

去调试

查询规则条件

hcloud IoTDA ShowRoutingRule

应用服务器可调用此接口查询物联网平台中指定规则条件的配置信息。

去调试

修改规则触发条件

hcloud IoTDA UpdateRoutingRule

应用服务器可调用此接口修改物联网平台中指定规则条件的配置参数。

去调试

删除规则触发条件

hcloud IoTDA DeleteRoutingRule

应用服务器可调用此接口删除物联网平台中的指定规则条件。

去调试

查询规则动作列表

hcloud IoTDA ListRuleActions

应用服务器可调用此接口查询物联网平台中设置的规则动作列表。

去调试

创建规则动作

hcloud IoTDA CreateRuleAction

应用服务器可调用此接口在物联网平台创建一条规则动作。

去调试

查询规则动作

hcloud IoTDA ShowRuleAction

应用服务器可调用此接口查询物联网平台中指定规则动作的配置信息。

去调试

修改规则动作

hcloud IoTDA UpdateRuleAction

应用服务器可调用此接口修改物联网平台中指定规则动作的配置。

去调试

删除规则动作

hcloud IoTDA DeleteRuleAction

应用服务器可调用此接口删除物联网平台中的指定规则动作。

去调试

数据转发积压策略管理

API名称

命令

描述

操作

新建数据流转积压策略

hcloud IoTDA CreateRoutingBacklogPolicy

应用服务器可调用此接口在物联网平台创建数据流转积压策略。

去调试

查询数据流转积压策略列表

hcloud IoTDA ListRoutingBacklogPolicy

应用服务器可调用此接口查询在物联网平台设置的数据流转积压策略列表。

去调试

修改数据流转积压策略

hcloud IoTDA UpdateRoutingBacklogPolicy

应用服务器可调用此接口在物联网平台修改指定数据流转积压策略。

去调试

查询数据流转积压策略

hcloud IoTDA ShowRoutingBacklogPolicy

应用服务器可调用此接口在物联网平台查询指定数据流转积压策略。

去调试

删除数据流转积压策略

hcloud IoTDA DeleteRoutingBacklogPolicy

应用服务器可调用此接口在物联网平台删除指定数据流转积压策略。

去调试

数据转发流控策略管理

API名称

命令

描述

操作

新建数据流转流控策略

hcloud IoTDA CreateRoutingFlowControlPolicy

应用服务器可调用此接口在物联网平台创建数据流转流控策略。

去调试

查询数据流转流控策略列表

hcloud IoTDA ListRoutingFlowControlPolicy

应用服务器可调用此接口查询在物联网平台设置的数据流转流控策略列表。

去调试

修改数据流转流控策略

hcloud IoTDA UpdateRoutingFlowControlPolicy

应用服务器可调用此接口在物联网平台修改指定数据流转流控策略。

去调试

查询数据流转流控策略

hcloud IoTDA ShowRoutingFlowControlPolicy

应用服务器可调用此接口在物联网平台查询指定数据流转流控策略。

去调试

删除数据流转流控策略

hcloud IoTDA DeleteRoutingFlowControlPolicy

应用服务器可调用此接口在物联网平台删除指定数据流转流控策略。

去调试

设备联动规则

API名称

命令

描述

操作

查询规则列表

hcloud IoTDA ListRules

应用服务器可调用此接口查询物联网平台中设置的规则列表。

去调试

创建规则

hcloud IoTDA CreateRule

应用服务器可调用此接口在物联网平台创建一条规则。

去调试

查询规则

hcloud IoTDA ShowRule

应用服务器可调用此接口查询物联网平台中指定规则的配置信息。

去调试

修改规则

hcloud IoTDA UpdateRule

应用服务器可调用此接口修改物联网平台中指定规则的配置。

去调试

删除规则

hcloud IoTDA DeleteRule

应用服务器可调用此接口删除物联网平台中的指定规则。

去调试

修改规则状态

hcloud IoTDA ChangeRuleStatus

应用服务器可调用此接口修改物联网平台中指定规则的状态,激活或者去激活规则。

去调试

设备影子

API名称

命令

描述

操作

查询设备影子数据

hcloud IoTDA ShowDeviceShadow

应用服务器可调用此接口查询指定设备的设备影子信息,包括对设备的期望属性信息(desired区)和设备最新上报的属性信息(reported区)。

去调试

配置设备影子预期数据

hcloud IoTDA UpdateDeviceShadowDesiredData

应用服务器可调用此接口配置设备影子的预期属性(desired区),当设备上线或者设备上报属性时把属性下发给设备。

去调试

删除设备影子数据

hcloud IoTDA DeleteDeviceShadow

应用服务器可调用此接口删除指定设备的设备影子信息,包括对设备的期望属性信息(desired区)和设备最新上报的属性信息(reported区)中的所有数据。

去调试

设备组管理

API名称

命令

描述

操作

查询设备组列表

hcloud IoTDA ListDeviceGroups

应用服务器可调用此接口查询物联网平台中的设备组信息列表。

去调试

添加设备组

hcloud IoTDA AddDeviceGroup

应用服务器可调用此接口新建设备组,一个华为云账号下最多可有1,000个设备组,包括父设备组和子设备组。设备组的最大层级关系不超过5层,即群组形成的关系树最大深度不超过5。

去调试

查询设备组

hcloud IoTDA ShowDeviceGroup

应用服务器可调用此接口查询指定设备组详情。

去调试

修改设备组

hcloud IoTDA UpdateDeviceGroup

应用服务器可调用此接口修改物联网平台中指定设备组。

去调试

删除设备组

hcloud IoTDA DeleteDeviceGroup

应用服务器可调用此接口删除指定设备组,如果该设备组存在子设备组或者该设备组中存在设备,必须先删除子设备组并将设备从该设备组移除,才能删除该设备组。

去调试

管理设备组中的设备

hcloud IoTDA CreateOrDeleteDeviceInGroup

应用服务器可调用此接口管理设备组中的设备。单个设备组内最多添加20,000个设备,一个设备最多可以被添加到10个设备组中。

去调试

查询设备组设备列表

hcloud IoTDA ShowDevicesInGroup

应用服务器可调用此接口查询指定设备组下的设备列表。

去调试

标签管理

API名称

命令

描述

操作

绑定标签

hcloud IoTDA TagDevice

应用服务器可调用此接口为指定资源绑定标签。当前支持标签的资源有Device(设备)。

去调试

解绑标签

hcloud IoTDA UntagDevice

应用服务器可调用此接口为指定资源解绑标签。当前支持标签的资源有Device(设备)。

去调试

按标签查询资源

hcloud IoTDA ListResourcesByTags

应用服务器可调用此接口查询绑定了指定标签的资源。当前支持标签的资源有Device(设备)。

去调试

资源空间管理

API名称

命令

描述

操作

查询资源空间列表

hcloud IoTDA ShowApplications

资源空间对应的是物联网平台原有的应用,在物联网平台的含义与应用一致,只是变更了名称。应用服务器可以调用此接口查询资源空间列表。

去调试

创建资源空间

hcloud IoTDA AddApplication

资源空间对应的是物联网平台原有的应用,在物联网平台的含义与应用一致,只是变更了名称。应用服务器可以调用此接口创建资源空间。

去调试

查询资源空间

hcloud IoTDA ShowApplication

资源空间对应的是物联网平台原有的应用,在物联网平台的含义与应用一致,只是变更了名称。应用服务器可以调用此接口查询指定资源空间详情。

去调试

删除资源空间

hcloud IoTDA DeleteApplication

删除指定资源空间。删除资源空间属于高危操作,删除资源空间后,该空间下的产品、设备等资源将不可用,请谨慎操作!

去调试

更新资源空间

hcloud IoTDA UpdateApplication

应用服务器可以调用此接口更新资源空间的名称。

去调试

批量任务

API名称

命令

描述

操作

查询批量任务列表

hcloud IoTDA ListBatchTasks

应用服务器可调用此接口查询物联网平台中批量任务列表,每一个任务又包括具体的任务内容、任务状态、任务完成情况统计等。

去调试

创建批量任务

hcloud IoTDA CreateBatchTask

应用服务器可调用此接口为创建批量处理任务,对多个设备进行批量操作。当前支持批量软固件升级、批量创建设备、批量删除设备、批量冻结设备、批量解冻设备、批量创建命令、批量创建消息任务。

去调试

查询批量任务

hcloud IoTDA ShowBatchTask

应用服务器可调用此接口查询物联网平台中指定批量任务的信息,包括任务内容、任务状态、任务完成情况统计以及子任务列表等。

去调试

删除批量任务

hcloud IoTDA DeleteBatchTask

应用服务器可调用此接口删除物联网平台中已经完成(状态为成功,失败、部分成功、已停止)的批量任务。

去调试

重试批量任务

hcloud IoTDA RetryBatchTask

应用服务器可调用此接口重试批量任务,目前只支持task_type为firmwareUpgrade,softwareUpgrade。如果task_id对应任务已经成功、停止、正在停止、等待中或初始化中,则不可以调用该接口。如果请求Body为{},则调用该接口后会重新执行所有状态为失败、失败待重试和已停止的子任务。

去调试

停止批量任务

hcloud IoTDA StopBatchTask

应用服务器可调用此接口停止批量任务,目前只支持task_type为firmwareUpgrade,softwareUpgrade。如果task_id对应任务已经完成(成功、失败、部分成功、已经停止)或正在停止中,则不可以调用该接口。如果请求Body为{},则调用该接口后会停止所有正在执行中、等待中和失败待重试状态的子任务。

去调试

确认执行批量任务

hcloud IoTDA ConfirmBatchTask

应用服务器可调用此接口确执行认批量任务,目前只支持task_type为firmwareUpgrade,softwareUpgrade和moduleUpgrade。如果task_id对应任务已经完成(成功、失败、部分成功、已经停止)或正在停止中,则不可以调用该接口。如果请求Body为{},则调用该接口后会确认执行所有处于等待中状态子任务。

去调试

批量任务的文件管理

API名称

命令

描述

操作

查询批量任务文件列表

hcloud IoTDA ListBatchTaskFiles

应用服务器可调用此接口查询批量任务文件列表。

去调试

上传批量任务文件

hcloud IoTDA UploadBatchTaskFile

应用服务器可调用此接口上传批量任务文件,用于创建批量任务。当前支持批量创建设备任务、批量删除设备任务、批量冻结设备任务、批量解冻设备任务的文件上传。

去调试

删除批量任务文件

hcloud IoTDA DeleteBatchTaskFile

应用服务器可调用此接口删除批量任务文件。

去调试

设备CA证书管理

API名称

命令

描述

操作

获取设备CA证书列表

hcloud IoTDA ListCertificates

应用服务器可调用此接口在物联网平台获取设备CA证书列表。

去调试

上传设备CA证书

hcloud IoTDA AddCertificate

应用服务器可调用此接口在物联网平台上传设备CA证书。

去调试

更新CA证书

hcloud IoTDA UpdateCertificate

应用服务器可调用此接口在物联网平台上更新CA证书。仅标准版实例、企业版实例支持该接口调用,基础版不支持。

去调试

删除设备CA证书

hcloud IoTDA DeleteCertificate

应用服务器可调用此接口在物联网平台删除设备CA证书。

去调试

查询CA证书

hcloud IoTDA ShowCertificate

应用服务器可调用此接口在物联网平台查询CA证书。

去调试

验证设备CA证书

hcloud IoTDA CheckCertificate

应用服务器可调用此接口在物联网平台验证设备的CA证书,目的是为了验证用户持有设备CA证书的私钥。

去调试

OTA升级包管理

API名称

命令

描述

操作

查询OTA升级包列表

hcloud IoTDA ListOtaPackageInfo

用户可调用此接口查询关联OBS对象的升级包列表。

去调试

创建OTA升级包

hcloud IoTDA CreateOtaPackage

用户可调用此接口创建升级包关联OBS对象。

去调试

获取OTA升级包详情

hcloud IoTDA ShowOtaPackage

用户可调用此接口查询关联OBS对象的升级包详情。

去调试

删除OTA升级包

hcloud IoTDA DeleteOtaPackage

用户可调用此接口删除关联OBS对象的升级包信息,不会删除OBS上对象。

去调试

设备隧道管理

API名称

命令

描述

操作

查询设备所有隧道

hcloud IoTDA ListDeviceTunnels

用户可通过该接口查询某项目下的所有设备隧道,以实现对设备管理。应用服务器可通过此接口向平台查询设备隧道建立的情况。

去调试

创建设备隧道

hcloud IoTDA AddTunnel

用户可以通过该接口创建隧道(WebSocket协议),应用服务器和设备可以通过该隧道进行数据传输。

去调试

查询设备隧道

hcloud IoTDA ShowDeviceTunnel

用户可通过该接口查询某项目中的某个设备隧道,查看该设备隧道的信息与连接情况。应用服务器可调用此接口向平台查询设备隧道建立情况。

去调试

关闭设备隧道

hcloud IoTDA CloseDeviceTunnel

应用服务器可通过该接口关闭某个设备隧道。关闭后可以再次连接。

去调试

删除设备隧道

hcloud IoTDA DeleteDeviceTunnel

用户可通过该接口删除某个设备隧道。删除后该通道不存在,无法再次连接。

去调试

设备代理

API名称

命令

描述

操作

查询设备代理列表

hcloud IoTDA ListDeviceProxies

应用服务器可调用此接口查询物联网平台中的设备代理列表。

去调试

创建设备代理

hcloud IoTDA CreateDeviceProxy

应用服务器可调用此接口在物联网平台创建一个动态设备代理规则,用于子设备自主选择网关设备上线和上报消息,即代理组下的任意网关下的子设备均可以通过代理组里其他设备上线(网关更新子设备状态)然后进行数据上报(网关批量设备属性上报)。

去调试

查询设备代理详情

hcloud IoTDA ShowDeviceProxy

应用服务器可调用此接口查询物联网平台中指定设备代理的详细信息。

去调试

修改设备代理

hcloud IoTDA UpdateDeviceProxy

应用服务器可调用此接口修改物联网平台中指定设备代理的基本信息。

去调试

删除设备代理

hcloud IoTDA DeleteDeviceProxy

应用服务器可调用此接口在物联网平台上删除指定设备代理。

去调试

广播消息

API名称

命令

描述

操作

下发广播消息

hcloud IoTDA BroadcastMessage

应用服务器可调用此接口向订阅了指定Topic的所有在线设备发布广播消息。应用将广播消息下发给平台后,平台会先返回应用响应结果,再将消息广播给设备。

去调试

网桥管理

API名称

命令

描述

操作

查询网桥列表

hcloud IoTDA ListBridges

应用服务器可调用此接口在物联网平台查询网桥列表。

去调试

创建网桥

hcloud IoTDA AddBridge

应用服务器可调用此接口在物联网平台创建一个网桥,仅在创建后的网桥才可以接入物联网平台。

去调试

删除网桥

hcloud IoTDA DeleteBridge

应用服务器可调用此接口在物联网平台上删除指定网桥。

去调试

重置网桥密钥

hcloud IoTDA ResetBridgeSecret

应用服务器可调用此接口在物联网平台上重置网桥密钥。

去调试

编解码函数管理

API名称

命令

描述

操作

查询编解码函数

hcloud IoTDA ListFunctions

提供查询编解码函数的功能。

去调试

创建编解码函数

hcloud IoTDA AddFunctions

提供创建编解码函数的功能。

去调试

删除编解码函数

hcloud IoTDA DeleteFunctions

提供删除编解码函数的功能。

去调试

预调配模板管理

API名称

命令

描述

操作

查询预调配模板列表

hcloud IoTDA ListProvisioningTemplates

应用服务器可调用此接口在物联网平台查询预调配模板列表。

去调试

创建预调配模板

hcloud IoTDA CreateProvisioningTemplate

应用服务器可调用此接口在物联网平台创建一个预调配模板。用户的设备未在平台注册时,可以通过预调配模板在设备首次接入物联网平台时将设备信息自动注册到物联网平台。

去调试

查询预调配模板详情

hcloud IoTDA ShowProvisioningTemplate

应用服务器可调用此接口在物联网平台查询指定预调配模板ID的详细信息。

去调试

更新指定id的预调配模板信息

hcloud IoTDA UpdateProvisioningTemplate

应用服务器可调用此接口在物联网平台更新指定id的预调配模板。

去调试

删除预调配模板

hcloud IoTDA DeleteProvisioningTemplate

应用服务器可调用此接口在物联网平台上删除指定预调配模板。

去调试

自定义鉴权

API名称

命令

描述

操作

查询自定义鉴权列表

hcloud IoTDA ListDeviceAuthorizers

应用服务器可调用此接口在物联网平台查询自定义鉴权列表。

去调试

创建自定义鉴权

hcloud IoTDA CreateDeviceAuthorizer

应用服务器可调用此接口在物联网平台创建一个自定义鉴权。自定义鉴权是指用户可以通过函数服务自定义实现鉴权逻辑,以对接入平台的设备进行身份认证。

去调试

查询自定义鉴权详情

hcloud IoTDA ShowDeviceAuthorizer

应用服务器可调用此接口在物联网平台查询指定自定义鉴权ID的详细信息。

去调试

更新指定id的自定义鉴权

hcloud IoTDA UpdateDeviceAuthorizer

应用服务器可调用此接口在物联网平台更新指定id的自定义鉴权。

去调试

删除自定义鉴权

hcloud IoTDA DeleteDeviceAuthorizer

应用服务器可调用此接口在物联网平台上删除指定自定义鉴权。

去调试

设备策略管理

API名称

命令

描述

操作

查询设备策略列表

hcloud IoTDA ListDevicePolicies

应用服务器可调用此接口在物联网平台查询策略列表。

去调试

创建设备策略

hcloud IoTDA CreateDevicePolicy

应用服务器可调用此接口在物联网平台创建一个策略,该策略需要绑定到设备和产品下才能生效。

去调试

查询设备策略详情

hcloud IoTDA ShowDevicePolicy

应用服务器可调用此接口在物联网平台查询指定策略ID的详细信息。

去调试

更新设备策略信息

hcloud IoTDA UpdateDevicePolicy

应用服务器可调用此接口在物联网平台更新策略。

去调试

删除设备策略

hcloud IoTDA DeleteDevicePolicy

应用服务器可调用此接口在物联网平台上删除指定策略,注意:删除策略同时会解绑该策略下所有绑定对象。

去调试

绑定设备策略

hcloud IoTDA BindDevicePolicy

应用服务器可调用此接口在物联网平台上为批量设备绑定目标策略,目前支持绑定目标类型为:设备、产品,当目标类型为产品时,该产品下所有设备都会生效。

去调试

解绑设备策略

hcloud IoTDA UnbindDevicePolicy

应用服务器可调用此接口在物联网平台上解除指定策略下绑定的目标对象。

去调试

查询设备策略绑定的目标列表

hcloud IoTDA ShowTargetsInDevicePolicy

应用服务器可调用此接口在物联网平台上查询指定策略ID下绑定的目标列表。

去调试

导出任务

API名称

命令

描述

操作

创建导出任务

hcloud IoTDA CreateExportTask

应用服务器可调用此接口创建资源导出任务。

去调试

查询导出任务列表

hcloud IoTDA ListExportTasks

应用服务器可调用此接口查询已创建的导出任务列表。

去调试

删除导出任务

hcloud IoTDA DeleteExportTask

应用服务器可调用此接口删除在平台创建的导出任务。

去调试

下载导出文件

hcloud IoTDA ShowExportTask

应用服务器可调用此接口下载已经完成的导出任务生成的文件。

去调试

鸿蒙软总线管理

API名称

命令

描述

操作

查询鸿蒙软总线列表

hcloud IoTDA ListHarmonySoftBus

应用服务器可调用此接口查询鸿蒙软总线列表。

去调试

创建鸿蒙软总线

hcloud IoTDA AddHarmonySoftBus

应用服务器可调用此接口新建鸿蒙软总线。

去调试

查询鸿蒙软总线

hcloud IoTDA ShowHarmonySoftBus

应用服务器可调用此接口查询指定ID的鸿蒙软总线。

去调试

删除鸿蒙软总线

hcloud IoTDA DeleteHarmonySoftBus

应用服务器可调用此接口删除指定鸿蒙软总线。

去调试

同步鸿蒙软总线信息

hcloud IoTDA CreateSyncHarmonySoftBus

应用服务器可调用此接口向组内设备同步鸿蒙软总线信息。

去调试

重置鸿蒙软总线密钥

hcloud IoTDA ResetHarmonySoftBusKey

应用服务器可调用此接口重置鸿蒙软总线密钥, 重置后状态变为未同步需要用户调用同步接口向组内设备同步最新密钥。

去调试

安全态势感知配置管理

API名称

命令

描述

操作

查询安全态势感知配置信息列表

hcloud IoTDA ListSecurityProfiles

应用服务器调用该接口查询安全态势感知配置列表。

去调试

创建或更新安全态势感知配置

hcloud IoTDA CreateSecurityProfile

应用服务器调用该接口创建安全态势感知配置。

去调试

查询某个具体id的安全态势感知配置详情

hcloud IoTDA ShowSecurityProfile

应用服务器可调用此接口查询某个具体id的安全态势感知配置详情。

去调试

更新某个具体id的安全态势感知配置信息

hcloud IoTDA UpdateSecurityProfile

应用服务器可调用此接口更新某个具体id的安全态势感知配置信息。

去调试

删除某个具体id的安全态势感知配置信息

hcloud IoTDA DeleteSecurityProfile

应用服务器可调用此接口删除某个具体id的安全态势感知配置信息。

去调试

设备鉴权模板管理

API名称

命令

描述

操作

查询设备鉴权模板列表

hcloud IoTDA ListDeviceAuthenticationTemplates

应用服务器可调用此接口在物联网平台查询设备鉴权模板列表。

去调试

创建设备鉴权模板

hcloud IoTDA CreateDeviceAuthenticationTemplate

应用服务器可调用此接口在物联网平台创建一个设备鉴权模板。

去调试

查询设备鉴权模板详情

hcloud IoTDA ShowDeviceAuthenticationTemplate

应用服务器可调用此接口在物联网平台查询指定设备鉴权模板ID的详细信息。

去调试

修改设备鉴权模板

hcloud IoTDA UpdateDeviceAuthenticationTemplate

应用服务器可调用此接口在物联网平台上修改指定设备鉴权模板。

去调试

删除设备鉴权模板

hcloud IoTDA DeleteDeviceAuthenticationTemplate

应用服务器可调用此接口在物联网平台上删除指定设备鉴权模板。

去调试

设备证书

API名称

命令

描述

操作

查询设备证书列表

hcloud IoTDA ListDeviceCertificate

应用服务器可调用此接口在物联网平台查询设备证书列表。

去调试

查询设备证书

hcloud IoTDA ShowDeviceCertificate

应用服务器可调用此接口在物联网平台查询指定设备证书。

去调试

更新设备证书

hcloud IoTDA UpdateDeviceCertificate

应用服务器可调用此接口在物联网平台更新一个设备证书状态。

去调试

删除设备证书

hcloud IoTDA DeleteDeviceCertificate

应用服务器可调用此接口在物联网平台删除一个设备证书。

去调试

查询使用指定设备证书的设备列表

hcloud IoTDA ListDeviceByDeviceCertificate

应用服务器可调用此接口在物联网平台查询使用指定设备证书的设备列表。

去调试

OTA模块管理

API名称

命令

描述

操作

创建OTA模块

hcloud IoTDA CreateOtaModule

用户可调用此接口创建产品的OTA模块,同一产品下最多自定义10个OTA模块。

去调试

查询OTA模块列表

hcloud IoTDA ListOtaModules

用户可调用此接口查询指定产品的OTA模块列表。

去调试

查询OTA模块详情

hcloud IoTDA ShowOtaModule

用户可调用此接口查询OTA模块详情。

去调试

删除OTA模块

hcloud IoTDA DeleteOtaModule

用户可调用此接口删除产品对应的OTA模块。

去调试

修改OTA模块

hcloud IoTDA UpdateOtaModule

用户可调用此接口修改对应的OTA模块的别名和描述。

去调试

域配置管理

API名称

命令

描述

操作

添加域配置

hcloud IoTDA CreateDomainConfiguration

应用服务器可调用此接口在物联网平台上添加域配置,域配置配额上限为:1个。

去调试

获取域配置列表

hcloud IoTDA ListDomainConfigurations

应用服务器可调用此接口在物联网平台获取域配置列表。

去调试

删除域配置

hcloud IoTDA DeleteDomainConfiguration

应用服务器可调用此接口在物联网平台删除域配置。

去调试

查询域配置

hcloud IoTDA ShowDomainConfiguration

应用服务器可调用此接口在物联网平台查询域配置。

去调试

更新域配置

hcloud IoTDA UpdateDomainConfiguration

应用服务器可调用此接口在物联网平台上更新域配置。

去调试

服务器证书管理

API名称

命令

描述

操作

添加服务器证书

hcloud IoTDA CreateServerCertificate

应用服务器可调用此接口在物联网平台上添加服务器证书,服务器证书配额限制为:2个。

去调试

获取服务器证书列表

hcloud IoTDA ListServerCertificate

应用服务器可调用此接口在物联网平台上获取服务器证书列表。

去调试

删除服务端证书

hcloud IoTDA DeleteServerCertificate

应用服务器可调用此接口在物联网平台删除服务器证书。

去调试

查询服务器证书

hcloud IoTDA ShowServerCertificate

应用服务器可调用此接口在物联网平台查询服务器证书。

去调试

泛协议配置管理

API名称

命令

描述

操作

创建泛协议配置

hcloud IoTDA CreateProtocolConfig

提供创建泛协议配置的功能,仅企业版白名单支持。

去调试

查询泛协议配置列表

hcloud IoTDA ListProtocolConfigs

提供查询泛协议配置列表的功能,仅企业版白名单支持。

去调试

删除泛协议配置

hcloud IoTDA DeleteProtocolConfig

提供删除泛协议配置的功能,仅企业版白名单支持。

去调试

查询泛协议配置详情

hcloud IoTDA ShowProtocolConfig

提供查询泛协议配置详情的功能,仅企业版白名单支持。

去调试

更新泛协议配置

hcloud IoTDA UpdateProtocolConfig

提供更新泛协议配置的功能,仅企业版白名单支持。

去调试

相关文档