检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,
绑定标签 功能介绍 应用服务器可调用此接口为指定资源绑定标签。当前支持标签的资源有Device(设备)。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/tags/bind-resource 表1 路径参数 参数 是否必选 参数类型 描述
设备的产品模型中定义了物联网平台可向设备下发的属性,应用服务器可调用此接口向指定设备下发属性。平台负责将属性以同步方式发送给设备,并将设备执行属性结果同步返回。 注意:此接口适用于MQTT设备,暂不支持NB-IoT设备。 调用方法 请参见如何调用API。 URI PUT /v5/iot/{projec
接口说明 MQTT CONNECT连接鉴权 设备请求引导消息 设备接收引导信息 父主题: 设备发放
创建设备隧道 功能介绍 用户可以通过该接口创建隧道(WebSocket协议),应用服务器和设备可以通过该隧道进行数据传输。 该API接口在基础版不支持。 该API调用后平台会向对应的MQTT/MQTTS设备下发隧道地址及密钥,同时给应用服务器也返回隧道地址及密钥,设备可以通过该地
用。可填参数可参考帮助文档数据流转下各接口的请求参数,如notify_data.body。 where 否 String 参数说明:用户自定义sql where语句,最大长度2500,该参数仅供标准版和企业版用户使用,可填参数可参考帮助文档数据流转下各接口的请求参数,如notify_data
查询设备所有隧道 功能介绍 用户可通过该接口查询某项目下的所有设备隧道,以实现对设备管理。应用服务器可通过此接口向平台查询设备隧道建立的情况。 该API接口在基础版不支持。 具体应用可见“设备远程登录”功能,请参见设备远程登录。 调用方法 请参见如何调用API。 URI GET /v5/i
创建设备策略 功能介绍 应用服务器可调用此接口在物联网平台创建一个策略,该策略需要绑定到设备和产品下才能生效。 一个实例最多能创建50个设备策略。 仅标准版实例、企业版实例支持该接口调用,基础版不支持。 调用方法 请参见如何调用API。 URI POST /v5/iot/{pro
重置网桥密钥 功能介绍 应用服务器可调用此接口在物联网平台上重置网桥密钥。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/bridges/{bridge_id}/reset-secret 表1 路径参数 参数 是否必选 参数类型 描述
按标签查询资源 功能介绍 应用服务器可调用此接口查询绑定了指定标签的资源。当前支持标签的资源有Device(设备)。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/tags/query-resources 表1 路径参数 参数 是否必选
是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id
重置设备指纹 功能介绍 应用服务器可调用此接口重置设备指纹。携带指定设备指纹时将之重置为指定值;不携带时将之置空,后续设备第一次接入时,该设备指纹的值将设置为第一次接入时的证书指纹。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/d
查询实例列表 功能介绍 用户可以调用此接口查询设备接入实例列表。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/iotda-instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见
应用端 URI 请求方法 POST URI /v5/iot/tunnels/{tunnel_id}/source-connect 传输协议 wss(Sec-Websocket) 请求参数 名称 必选 类型 位置 说明 tunnel_access_token 是 String Header
设备端 URI 请求方法 POST URI /v5/iot/tunnels/{tunnel_id}/device-connect 传输协议 wss(Sec-Websocket) 请求参数 名称 必选 类型 位置 说明 tunnel_access_token 是 String Header
删除实例 功能介绍 删除设备接入实例。约束:此接口仅支持删除按需计费的实例。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/iotda-instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述
删除设备隧道 功能介绍 用户可通过该接口删除某个设备隧道。删除后该通道不存在,无法再次连接。 该API接口在基础版不支持。 具体应用可见“设备远程登录”功能,请参见设备远程登录。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/tunnels/{tunnel_id}
是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数
物联网平台可向设备下发消息,应用服务器可调用此接口向指定设备下发消息,以实现对设备的控制。应用将消息下发给平台后,平台返回应用响应结果,平台再将消息发送给设备。平台返回应用响应结果不一定是设备接收结果,建议用户应用通过订阅设备消息状态变更通知,订阅后平台会将设备接收结果推送给订阅的应用。 注意: 此接口适用于MQT
创建设备接入实例 功能介绍 用户可以调用此接口创建一个设备接入实例。支持的实例规格请参见产品规格说明。 接口约束: 请保证账户余额充足,此接口无法使用优惠券支付,在创建包年/包月实例时,若余额不足会创建一个待支付订单。 若想使用优惠券,请将请求中的is_auto_pay字段设置为