检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
资源空间管理 接入凭证是用于AMQP、MQTTS等协议建立长链接时认证使用。 查询资源空间列表 创建资源空间 查询资源空间 删除资源空间 更新资源空间 父主题: API
预调配模板管理 创建预调配模板 查询预调配模板列表 删除预调配模板 查询预调配模板详情 更新指定id的预调配模板信息 父主题: API
删除实例 功能介绍 删除设备接入实例。约束:此接口仅支持删除按需计费的实例。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/iotda-instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述
AMQP队列管理 创建AMQP队列 查询AMQP列表 查询单个AMQP队列 删除AMQP队列 父主题: API
OTA升级包管理 创建OTA升级包 查询OTA升级包列表 获取OTA升级包详情 删除OTA升级包 父主题: API
编解码函数管理 提供编解码函数管理功能。 创建编解码函数 查询编解码函数 删除编解码函数 父主题: API
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于创建产品接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头
获取项目ID 从控制台获取项目ID 在调用接口时,部分URI以及请求体中需要填入项目ID,项目ID获取步骤如下: 在华为云首页右上角,单击“控制台”。 在右上角的用户名中选择“我的凭证”。 在“我的凭证”界面,API凭证页签中,查看项目ID。 图1 API凭证-获取项目ID 调用API
关闭设备隧道 功能介绍 应用服务器可通过该接口关闭某个设备隧道。关闭后可以再次连接。 该API接口在基础版不支持。 具体应用可见“设备远程登录”功能,请参见设备远程登录。 调用方法 请参见如何调用API。 URI PUT /v5/iot/{project_id}/tunnels/{
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。 Token认证 Token是服务端生成的一串字符串
安全隧道协议消息交互说明 当应用端与设备端建立安全隧道的WebSocket连接后,应用端与设备端将基于安全隧道协议进行消息通信,数据格式如下: 名称 类型 说明 operation_type String 参数说明: 数据类型。 取值范围: connect_tunnel:平台通知应用端设备已连接
创建网桥 功能介绍 应用服务器可调用此接口在物联网平台创建一个网桥,仅在创建后的网桥才可以接入物联网平台。 一个实例最多支持20个网桥。 仅标准版实例、企业版实例支持该接口调用,基础版不支持。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id
下发广播消息 功能介绍 应用服务器可调用此接口向订阅了指定Topic的所有在线设备发布广播消息。应用将广播消息下发给平台后,平台会先返回应用响应结果,再将消息广播给设备。 注意: 此接口只适用于使用MQTT协议接入的设备。 调用方法 请参见如何调用API。 URI POST /v5
删除批量任务 功能介绍 应用服务器可调用此接口删除物联网平台中已经完成(状态为成功,失败,部分成功,已停止)的批量任务。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/batchtasks/{task_id} 表1 路径参数 参数
重试批量任务 功能介绍 应用服务器可调用此接口重试批量任务,目前只支持task_type为firmwareUpgrade,softwareUpgrade。如果task_id对应任务已经成功、停止、正在停止、等待中或初始化中,则不可以调用该接口。如果请求Body为{},则调用该接口后会重新执行所有状态为失败
查询实例详情 功能介绍 查询设备接入实例详情。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/iotda-instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
删除实例标签 功能介绍 删除实例标签。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/iotda-instances/{instance_id}/unbind-tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id
解绑标签 功能介绍 应用服务器可调用此接口为指定资源解绑标签。当前支持标签的资源有Device(设备)。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/tags/unbind-resource 表1 路径参数 参数 是否必选 参数类型
查询设备属性 功能介绍 设备的产品模型中定义了物联网平台可向设备下发的属性,应用服务器可调用此接口向设备发送指令用以查询设备的实时属性, 并由设备将属性查询的结果同步返回给应用服务器。 注意:此接口适用于MQTT设备,暂不支持NB-IoT设备。 调用方法 请参见如何调用API。 URI
设备同步命令 下发设备命令 父主题: 设备命令