检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
该设备隧道的信息与连接情况。应用服务器可调用此接口向平台查询设备隧道建立情况。 该API接口在基础版不支持。 具体应用可见“设备远程登录”功能,请参见设备远程登录。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/tunnels/{tunnel_id}
接入凭证是用于客户端使用AMQP等协议与平台建链的一个认证凭据。只保留一条记录,如果重复调用只会重置接入凭证,使得之前的失效。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/auth/accesscode 表1 路径参数 参数 是否必选 参数类型 描述
此接口适用于MQTT设备消息下发,暂不支持其他协议接入的设备消息下发。 此接口仅支持单个设备消息下发,如需多个设备消息下发,请参见 创建批量任务。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/devices/{device_id}/messages 表1 路径参数 参数
接口约束:当前实例的规格支持包年/包月计费模式时,才可以修改实例的计费模式为包年/包月。支持的实例规格请参见产品规格说明。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/iotda-instances/{instance_id}/change-charge-mode
功能介绍 用户可通过该接口删除某个设备隧道。删除后该通道不存在,无法再次连接。 该API接口在基础版不支持。 具体应用可见“设备远程登录”功能,请参见设备远程登录。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/tunnels/{tunnel_id}
参数说明:设备属性的步长。 unit 否 String 参数说明:设备属性的单位。 最大长度:16 method 是 String 参数说明:设备属性的访问模式。取值范围:RWE,RW,RE,WE,E,W,R。 R:属性值可读 W:属性值可写 E:属性值可订阅,即属性值变化时上报事件。 description
应用服务器可调用此接口删除已导入物联网平台的指定产品模型。此接口仅删除了产品,未删除关联的插件,在产品下存在设备时,该产品不允许删除。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/products/{product_id} 表1 路径参数 参数 是否必选
重置网桥密钥 功能介绍 应用服务器可调用此接口在物联网平台上重置网桥密钥。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/bridges/{bridge_id}/reset-secret 表1 路径参数 参数 是否必选 参数类型 描述
Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,仅在物理多租场景下从管理面访问API时需要携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID。 响应参数 无 请求示例 删除指定规则动作。
String 参数解释: 文件上传URL。 bucket_name 可选 String 参数解释: OBS桶的名称。 object_name 可选 String 参数解释: OBS待上传对象名称,与file_name一致。 expire 可选 Integer 参数解释: URL过期时间,单位:秒。
用户可通过该接口查询某项目下的所有设备隧道,以实现对设备管理。应用服务器可通过此接口向平台查询设备隧道建立的情况。 该API接口在基础版不支持。 具体应用可见“设备远程登录”功能,请参见设备远程登录。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/tunnels 表1 路径参数
参数说明:当前自定义鉴权是否为默认的鉴权方式,默认为false,当设置为true时,用户所有支持SNI的设备,如果在鉴权时不指定使用特定的设备鉴权,将统一使用当前鉴权器策略进行鉴权。 status String 参数说明:是否激活该鉴权方式 ACTIVE:该鉴权为激活状态。 INACTIVE:该鉴权为停用状态。
删除批量任务 功能介绍 应用服务器可调用此接口删除物联网平台中已经完成(状态为成功,失败,部分成功,已停止)的批量任务。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/batchtasks/{task_id} 表1 路径参数 参数 是否必选
查询设备策略详情 功能介绍 应用服务器可调用此接口在物联网平台查询指定策略ID的详细信息。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/device-policies/{policy_id} 表1 路径参数 参数 是否必选 参数类型
查询实例列表 功能介绍 用户可以调用此接口查询设备接入实例列表。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/iotda-instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见
创建设备隧道 功能介绍 用户可以通过该接口创建隧道(WebSocket协议),应用服务器和设备可以通过该隧道进行数据传输。 该API接口在基础版不支持。 该API调用后平台会向对应的MQTT/MQTTS设备下发隧道地址及密钥,同时给应用服务器也返回隧道地址及密钥,设备可以通过该地址及密钥创建WebSocket协议连接。
按标签查询资源 功能介绍 应用服务器可调用此接口查询绑定了指定标签的资源。当前支持标签的资源有Device(设备)。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/tags/query-resources 表1 路径参数 参数 是否必选 参数类型
资源空间对应的是物联网平台原有的应用,在物联网平台的含义与应用一致,只是变更了名称。应用服务器可以调用此接口创建资源空间。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/apps 表1 路径参数 参数 是否必选 参数类型 描述 project_id
)然后进行数据上报(网关批量设备属性上报 )。 单实例最多可以配置10个设备代理 单账号调用该接口的 TPS 限制最大为1/S(每秒1次请求数) 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/device-proxies 表1 路径参数 参数 是否必选 参数类型 描述
功能介绍 应用服务器可调用此接口查询已在物联网平台的创建的指定产品模型详细信息,包括产品模型的服务、属性、命令等。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/products/{product_id} 表1 路径参数 参数 是否必选 参数类型