更新时间:2024-05-14 GMT+08:00

API使用指导

为了降低应用侧的开发难度、提升应用侧开发效率,物联网平台向应用侧开放了API(Application Programming Interface)。您可以调用开放的API,快速集成物联网平台的功能,如产品管理、设备管理、订阅管理、设备命令、规则管理等功能。

应用侧需要通过IAM服务鉴权,获取token,详细步骤可参考调测“获取IAM用户Token”接口

应用开发资源

为了降低应用的开发难度、提升开发效率,物联网平台开放了应用侧API。应用通过调用物联网平台的API,实现安全接入、设备管理、数据采集、命令下发等业务场景。

资源包名

描述

下载

应用侧开发 API Java Demo

物联网平台为应用服务器提供了应用侧API,能够让开发者快速验证API开放的能力,体验业务功能,熟悉业务流程。

API Java Demo

应用侧开发 Java SDK

Java SDK提供Java方法调用应用侧API与平台通信。使用指南可以参考Java SDK使用指南

Java SDK

应用侧开发 C# SDK

C# SDK提供C#方法调用应用侧API与平台通信。使用指南可以参考C# SDK使用指南

C# SDK

应用侧开发 Python SDK

Python SDK提供Python方法调用应用侧API与平台通信。使用指南可以参考Python SDK使用指南

Python SDK

应用侧开发 Go SDK

Go SDK提供Go方法调用应用侧API与平台通信。使用指南可以参考Go SDK使用指南

Go SDK

应用侧开发 Node.js SDK

Node.js SDK提供Node.js方法调用应用侧API与平台通信。使用指南可以参考Node.js SDK使用指南

Node.js SDK

应用侧开发 PHP SDK

PHP SDK提供PHP方法调用应用侧API与平台通信。使用指南可以参考PHP SDK使用指南

PHP SDK

接口介绍

API分组

应用场景

产品管理

产品模型定义了该产品下所有设备具备的能力或特征,产品管理为应用服务器提供对已导入物联网平台中产品模型的操作管理功能。

设备管理

设备管理为应用服务器提供对设备的操作管理功能,包括对设备基本信息和设备数据的操作。

设备消息

设备消息为应用服务器提供向设备透传消息的功能。

设备命令

设备的产品模型中定义了物联网平台可向设备下发的命令,设备命令为应用服务器提供向设备下发命令的功能,实现对设备的控制操作。

设备属性

设备的产品模型中定义了物联网平台可向设备下发的属性,设备属性为应用服务器提供向设备下发属性的功能。

AMQP队列管理

AMQP队列管理为客户创建、删除、查看队列。AMQP队列可通过规则订阅后通过AMQP客户端接收消息数据。

接入凭证管理

接入凭证是用于AMQP、MQTTS等协议建立长链接时认证使用。

数据转发设备联动

规则管理为应用服务器提供物联网平台的规则引擎功能,通过设置规则实现业务的联动变化或将数据转发至其他华为云服务。包含设备联动和数据转发两种类型。

  • 设备联动:包含触发条件和执行动作两部分。当满足设置的触发条件后,触发相应动作,如“下发命令”“发送通知”“上报告警”“恢复告警”
  • 数据转发:包含设置转发数据、设置转发目标和启动规则三部分。支持转发至“数据接入服务DIS”“分布式消息服务 Kafka”“对象存储服务 OBS”“应用与数据集成平台 ROMA Connect”“第三方应用服务(HTTP推送)”“AMQP推送消息队列”、、、。

订阅管理

订阅管理为应用服务器提供对物联网平台资源的订阅功能,若订阅的资源发生变化,平台会通知应用服务器。

设备影子

设备影子是一个用于存储和检索设备当前状态信息的文件,设备影子为应用服务器提供对设备影子的操作管理功能。

  • 每个设备有且只有一个设备影子,由设备ID唯一标识。
  • 设备影子仅保存最近一次设备的上报数据和用户设置的预期数据。
  • 无论该设备是否在线,都可以通过该影子查询和设置设备的状态。

设备组管理

设备组管理为应用服务器提供对设备组的管理操作功能,包括对设备组信息和设备组设备的操作。

标签管理

标签可用于对资源进行分类,标签管理为应用服务器提供对各类资源绑定和解绑标签功能。

当前仅设备支持标签。

资源空间管理

资源空间管理为应用服务器提供对资源空间的管理能力,包括资源空间的增删改查。

批量任务

批量任务为应用服务器提供批量处理功能,对接入物联网平台的设备进行批量操作。

  • 目前提供批量软、固件升级,批量创建/删除/更新设备,批量冻结/解冻设备,批量创建同步/异步命令,批量创建消息和批量配置设备影子的能力。
  • 当前单用户单一任务类型的未完成的任务最大为10,超过则无法创建新的任务。

设备CA证书管理

设备CA证书管理为应用服务器提供对设备CA证书进行操作管理功能,包括对设备CA证书进行上传、验证、查询等操作。物联网平台支持使用证书进行设备接入认证。

OTA升级包管理

OTA升级包管理为应用服务器提供对升级包进行操作管理功能,包括对升级包的创建、查询、删除等操作。

广播消息

广播消息为应用服务器向订阅了指定Topic的所有在线设备发布消息。

设备隧道管理

设备隧道可用于应用服务器与设备进行数据传输。

数据流转积压策略管理

数据流转积压策略管理为应用服务器提供了对积压策略的管理操作功能,包括对数据流转积压策略的创建,查询,修改删除等操作功能。

数据流转流控策略管理

数据流转流控策略管理为应用服务器提供了对流控策略的管理操作功能,包括对数据流转流控策略的创建,查询,修改删除等操作功能。