API概览
调用以下接口前，请先参考认证鉴权完成认证鉴权操作。
产品管理
|
API |
说明 |
|---|---|
|
查询已导入物联网平台的产品模型信息列表，了解产品模型的概要信息。 |
|
|
创建产品。此接口仅创建了产品，没有创建和安装插件，如果需要对数据进行编解码，还需要在平台开发和安装插件。 |
|
|
查询已导入物联网平台的指定产品模型详细信息，包括产品模型的服务、属性、命令等。 |
|
|
修改已导入物联网平台的指定产品模型，包括产品模型的服务、属性、命令等。此接口仅修改了产品，未修改和安装插件，如果修改了产品中的service定义，且在平台中有对应的插件，请修改并重新安装插件。 |
|
|
删除已导入物联网平台的指定产品模型。 |
设备管理
|
API |
说明 |
|---|---|
|
查询物联网平台中的设备信息列表。 |
|
|
在物联网平台注册一个设备，仅在注册后设备才可以接入物联网平台。 |
|
|
查询物联网平台中指定设备的详细信息。 |
|
|
修改物联网平台中指定设备的基本信息。 |
|
|
在物联网平台上删除指定设备。若设备下连接了非直连设备，则必须把设备下的非直连设备都删除后，才能删除该设备。 |
|
|
重置设备密钥，携带指定密钥时平台将设备密钥重置为指定的密钥，不携带密钥时平台将自动生成一个新的随机密钥返回。 |
|
|
冻结设备，设备冻结后不能再连接上线，可以通过解冻设备接口解除设备冻结。注意，当前仅支持冻结与平台直连的设备。 |
|
|
解冻设备，解除冻结后，设备可以连接上线。 |
|
|
应用服务器可调用此接口重置设备指纹。携带指定设备指纹时将之重置为指定值；不携带时将之置空。 |
|
|
应用服务器可调用此接口修改设备网关。将当前设备的网关设备切换至指定设备。 |
|
|
应用服务器使用SQL语句调用该接口，灵活的搜索所需要的设备资源列表。 |
|
|
应用服务器调用该接口查询设备加入的设备组列表。 |
设备消息
|
API |
说明 |
|---|---|
|
查询指定设备下的消息，平台为每个设备默认最多保存20条消息，超过20条后， 后续的消息会替换下发最早的消息。 |
|
|
向设备下发消息，应用服务器可调用此接口向指定设备下发消息，以实现对设备的控制。应用将消息下发给平台后，平台返回应用响应结果，平台再将消息发送给设备。 |
|
|
查询指定消息id的消息。 |
设备命令
|
API |
说明 |
|---|---|
|
设备的产品模型中定义了物联网平台可向设备下发的命令，应用服务器可调用此接口向指定设备下发同步命令，以实现对设备的同步控制。 |
|
|
设备的产品模型中定义了物联网平台可向设备下发的命令，应用服务器可调用此接口向指定设备下发异步命令，以实现对设备的控制。 |
|
|
可通过指定id查询某条特定命令。 |
设备属性
|
API |
说明 |
|---|---|
|
设备的产品模型中定义了物联网平台可向设备下发的属性，应用服务器可调用此接口查询指定设备下属性。 |
|
|
设备的产品模型中定义了物联网平台可向设备下发的属性，应用服务器可调用此接口向指定设备下发属性。平台负责将属性以同步方式发送给设备，并将设备执行属性结果同步返回。 |
AMQP队列管理
|
API |
说明 |
|---|---|
|
可调用此接口查询物联网平台中的AMQP队列信息列表。 |
|
|
可调用此接口在物联网平台创建AMQP队列。您可以通过调用数据流转规则管理接口，将数据推送到此AMQP队列。 |
|
|
可调用此接口查询物联网平台中指定队列的详细信息。 |
|
|
可调用此接口在物联网平台上删除指定AMQP队列。 |
接入凭证管理
|
API |
说明 |
|---|---|
|
接入码是用于客户端使用AMQP等协议与平台建链的一个认证凭据，调用该接口将会生成一对新的接入码。 |
数据流转规则管理
|
API |
说明 |
|---|---|
|
可调用此接口查询物联网平台中设置的规则条件列表。 |
|
|
可调用此接口在物联网平台创建一条规则触发条件。 |
|
|
可调用此接口查询物联网平台中指定规则条件的配置信息。 |
|
|
可调用此接口修改物联网平台中指定规则条件的配置参数。 |
|
|
可调用此接口删除物联网平台中的指定规则条件。 |
|
|
可调用此接口查询物联网平台中设置的规则动作列表。 |
|
|
可调用此接口在物联网平台创建一条规则动作。 |
|
|
可调用此接口查询物联网平台中指定规则动作的配置信息。 |
|
|
可调用此接口修改物联网平台中指定规则动作。 |
|
|
可调用此接口删除物联网平台中的指定规则动作。 |
流转数据
|
API |
说明 |
|---|---|
|
应用服务器在物联网平台创建设备状态变更通知规则后，当物联网平台中的设备状态发生变更时，平台会向应用服务器推送通知消息。 |
|
|
应用服务器在物联网平台创建了设备属性上报通知规则后，当设备上报属性数据时，平台会向应用服务器推送通知消息。 |
|
|
应用服务器在物联网平台创建了消息状态变更通知规则后，当设备消息状态变更时，平台会向应用服务器推送通知消息。 |
|
|
应用服务器在物联网平台创建了批量任务状态变更通知规则后，当批量任务状态变更时，平台会向应用服务器推送通知消息。 |
|
|
应用服务器在物联网平台创建了设备消息上报通知规则后，当设备上报消息数据时，平台会向应用服务器推送通知消息。 |
|
|
应用服务器在物联网平台创建了设备添加事件规则后，当物联网平台中的设备添加时，平台会向应用服务器推送通知消息。 |
|
|
应用服务器在物联网平台创建了设备更新事件规则后，当物联网平台中的设备更新时，平台会向应用服务器推送通知消息。 |
|
|
应用服务器在物联网平台创建了设备删除通知事件规则后，当物联网平台中的设备删除时，平台会向应用服务器推送通知消息。 |
|
|
应用服务器在物联网平台创建了产品添加通知事件规则后，当物联网平台中的产品添加时，平台会向应用服务器推送通知消息。 |
|
|
应用服务器在物联网平台创建了产品更新通知事件规则后，当物联网平台中的产品更新时，平台会向应用服务器推送通知消息。 |
|
|
应用服务器在物联网平台创建了产品删除通知事件规则后，当物联网平台中的产品删除时，平台会向应用服务器推送通知消息。 |
|
|
应用服务器在物联网平台创建了命令状态变更通知后，当命令状态变更时，平台会向应用服务器推送通知消息。 |
设备联动规则
|
API |
说明 |
|---|---|
|
查询物联网平台中设置的设备联动规则列表。 |
|
|
在物联网平台创建一条设备联动规则。 |
|
|
查询物联网平台中指定规则的配置信息。 |
|
|
修改物联网平台中指定规则的配置。 |
|
|
删除物联网平台中的指定规则。 |
|
|
修改物联网平台中指定规则的状态，激活或者去激活规则。 |
设备影子
|
API |
说明 |
|---|---|
|
查询指定设备的设备影子信息，包括对设备的配置信息（desired区）和设备最新上报的数据信息（reported区）。 |
|
|
应用服务器可调用此接口删除指定设备的设备影子信息，包括对设备的期望属性信息（desired区）和设备最新上报的属性信息（reported区）中的所有数据。 |
|
|
配置设备影子的预期数据（desired区），当设备上线时把数据下发给设备。设备影子的属性和产品模型耦合在一起，配置的预期属性需在产品模型中定义且method具有可写属性“W”才可下发。 |
设备组管理
|
API |
说明 |
|---|---|
|
查询物联网平台中的设备组信息列表。 |
|
|
新建设备组，一个华为云账号下最多可有1,000个分组，包括父分组和子分组。 |
|
|
查询设备组详情。 |
|
|
修改指定设备组。 |
|
|
删除指定设备组。 |
|
|
管理设备组中的设备，包括添加设备到设备组和从设备组删除设备。单个设备组内最多添加20,000个设备。一个设备最多可以被添加到10个设备组中。 |
|
|
查询指定设备组下的设备列表。 |
标签管理
|
API |
说明 |
|---|---|
|
为指定资源绑定标签。当前仅支持为设备绑定标签。 |
|
|
为指定资源解绑标签。当前仅支持为设备解绑标签。 |
|
|
查询绑定了指定标签的资源。 |
实例管理
|
API |
说明 |
|---|---|
|
用户可以调用此接口创建一个设备接入实例。 |
|
|
用户可以调用此接口查询设备接入实例列表。 |
|
|
查询设备接入实例详情。 |
|
|
修改设备接入实例信息。 |
|
|
删除设备接入实例。约束：此接口仅支持删除按需计费的实例。 |
|
|
修改设备接入实例的规格。 |
|
|
修改设备接入实例的计费模式，支持将按需计费模式修改为包年/包月计费模式。 |
|
|
添加实例标签。 |
|
|
删除实例标签。 |
实例规格管理
|
API |
说明 |
|---|---|
|
用户可以调用此接口查询设备接入服务支持的实例规格列表。 |
实例任务管理
|
API |
说明 |
|---|---|
|
用户可以调用此接口查询设备接入实例任务列表。接口约束：仅支持查询180天内的实例任务，实例任务的最大数量为20条。 |
|
|
用户可以调用此接口查询设备接入实例任务详情。 |
|
|
用户可以调用此接口对运行失败的实例任务进行重试。 |
资源空间管理
|
API |
说明 |
|---|---|
|
资源空间对应的是物联网平台原有的应用，在物联网平台的含义与应用一致，只是变更了名称。应用服务器可以调用此接口查询资源空间列表。 |
|
|
资源空间对应的是物联网平台原有的应用，在物联网平台的含义与应用一致，只是变更了名称。应用服务器可以调用此接口创建资源空间。 |
|
|
资源空间对应的是物联网平台原有的应用，在物联网平台的含义与应用一致，只是变更了名称。应用服务器可以调用此接口查询指定资源空间详情。 |
|
|
删除指定资源空间。删除资源空间属于高危操作，删除资源空间后，该空间下的产品、设备等资源将不可用，请谨慎操作！ |
批量任务
|
API |
说明 |
|---|---|
|
查询物联网平台中批量任务列表，每一个任务又包括具体的任务内容、任务状态、任务完成情况统计等。 |
|
|
创建批量处理任务，对多个设备进行批量操作。当前支持批量软固件升级、批量创建设备、批量修改设备、批量删除设备、批量冻结设备、批量解冻设备、批量创建命令、批量创建消息、批量配置设备影子和批量更新设备任务。 |
|
|
查询物联网平台中指定批量任务的信息，包括任务内容、任务状态、任务完成情况统计以及子任务列表等。 |
|
|
应用服务器可调用此接口删除物联网平台中已经完成（状态为成功，失败，部分成功，已停止）的批量任务。 |
|
|
应用服务器可调用此接口重试批量任务，目前只支持task_type为firmwareUpgrade，softwareUpgrade。如果task_id对应任务已经成功、停止、正在停止、等待中或初始化中，则不可以调用该接口。 |
|
|
应用服务器可调用此接口停止批量任务，目前只支持task_type为firmwareUpgrade，softwareUpgrade。如果task_id对应任务已经完成（成功、失败、部分成功，已经停止）或正在停止中，则不可以调用该接口。 |
|
|
查询批量任务文件列表。 |
|
|
上传批量任务文件，用于创建批量任务。当前支持批量创建设备任务、批量删除设备任务、批量冻结设备任务、批量解冻设备和批量更新设备任务的文件上传。 |
|
|
删除批量任务文件。 |
设备CA证书管理
|
API |
说明 |
|---|---|
|
获取设备的CA证书列表。 |
|
|
上传设备的CA证书。 |
|
|
删除设备的CA证书。 |
|
|
验证设备的CA证书，目的是为了验证用户持有设备CA证书的私钥。 |
|
|
更新设备CA证书。 |
OTA升级包管理
|
API |
说明 |
|---|---|
|
用户可调用此接口创建升级包关联OBS对象。 |
|
|
用户可调用此接口查询关联OBS对象的升级包列表。 |
|
|
用户可调用此接口查询关联OBS对象的升级包详情。 |
|
|
用户可调用此接口删除关联OBS对象的升级包信息，不会删除OBS上对象。 |
广播消息
|
API |
说明 |
|---|---|
|
应用服务器可调用此接口向订阅了指定Topic的所有在线设备发布广播消息。 |
设备隧道管理
|
API |
说明 |
|---|---|
|
应用服务器可调用此接口创建隧道。 |
|
|
应用服务器可调用此接口查询所有设备隧道。 |
|
|
应用服务器可调用此接口查询设备隧道详情。 |
|
|
应用服务器可调用此接口关闭隧道。 |
|
|
应用服务器可调用此接口删除隧道。 |
设备代理
|
API |
说明 |
|---|---|
|
应用服务器可调用此接口设备代理。 |
|
|
应用服务器可调用此接口查询所有设备代理。 |
|
|
应用服务器可调用此接口查询设备代理详情。 |
|
|
应用服务器可调用此接口修改设备代理。 |
|
|
应用服务器可调用此接口删除设备代理。 |
网桥管理
|
API |
说明 |
|---|---|
|
应用服务器可调用此接口网桥。 |
|
|
应用服务器可调用此接口查询所有网桥。 |
|
|
应用服务器可调用此接口删除网桥。 |
|
|
应用服务器可调用此接口重置网桥密码。 |
设备策略管理
|
API |
说明 |
|---|---|
|
应用服务器可调用此接口创建设备策略。 |
|
|
应用服务器可调用此接口查询所有设备策略。 |
|
|
应用服务器可调用此接口删除设备策略。 |
|
|
应用服务器可调用此接口查询设备策略详情。 |
|
|
应用服务器可调用此接口更新设备策略信息。 |
|
|
应用服务器可调用此接口绑定设备策略。 |
|
|
应用服务器可调用此接口解绑设备策略。 |
|
|
应用服务器可调用此接口查询该设备策略绑定的目标列表。 |
预调配模板管理
|
API |
说明 |
|---|---|
|
应用服务器可调用此接口创建创建预调配模板。 |
|
|
应用服务器可调用此接口查询所有创建预调配模板。 |
|
|
应用服务器可调用此接口删除预调配模板。 |
|
|
应用服务器可调用此接口查询创建预调配模板详情。 |
|
|
应用服务器可调用此接口更新指定id的预调配模板信息。 |
自定义鉴权
|
API |
说明 |
|---|---|
|
应用服务器可调用此接口创建自定义鉴权。 |
|
|
应用服务器可调用此接口查询所有自定义鉴权。 |
|
|
应用服务器可调用此接口删除自定义鉴权。 |
|
|
应用服务器可调用此接口查询自定义鉴权详情。 |
|
|
应用服务器可调用此接口更新指定id的自定义鉴权。 |
安全态势感知
|
API |
说明 |
|---|---|
|
应用服务器调用该接口查询安全态势感知配置列表。 |
|
|
应用服务器调用该接口创建安全态势感知配置。 |
|
|
应用服务器可调用此接口查询某个具体id的安全态势感知配置详情。 |
|
|
应用服务器可调用此接口删除某个具体id的安全态势感知配置信息。 |
|
|
应用服务器可调用此接口更新某个具体id的安全态势感知配置信息。 |
鸿蒙软总线
|
API |
说明 |
|---|---|
|
应用服务器可调用此接口新建鸿蒙软总线。 |
|
|
应用服务器可调用此接口查询鸿蒙软总线列表。 |
|
|
应用服务器可调用此接口删除自定义鉴权。 |
|
|
应用服务器可调用此接口删除指定鸿蒙软总线。 |
|
|
应用服务器可调用此接口向组内设备同步鸿蒙软总线信息。 |
|
|
应用服务器可调用此接口重置鸿蒙软总线密钥。 |
设备证书
|
API |
说明 |
|---|---|
|
应用服务器可调用此接口在物联网平台查询设备证书列表。 |
|
|
应用服务器可调用此接口在物联网平台更新一个设备证书状态。 |
|
|
应用服务器可调用此接口在物联网平台更新一个设备证书状态。 |
|
|
应用服务器可调用此接口在物联网平台删除一个设备证书。 |
|
|
应用服务器可调用此接口在物联网平台查询使用指定设备证书的设备列表。 |
设备鉴权模板
|
API |
说明 |
|---|---|
|
应用服务器可调用此接口在物联网平台创建一个设备鉴权模板。 |
|
|
应用服务器可调用此接口在物联网平台查询设备鉴权模板列表。 |
|
|
应用服务器可调用此接口在物联网平台上删除指定设备鉴权模板。 |
|
|
应用服务器可调用此接口在物联网平台上修改指定设备鉴权模板。 |
|
|
应用服务器可调用此接口在物联网平台查询指定设备鉴权模板ID的详细信息。 |
