正在生成
详细信息:
检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建产品 功能介绍 应用服务器可调用此接口创建产品。此接口仅创建了产品,没有创建和安装插件,如果需要对数据进行编解码,还需要在平台开发和安装插件。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/products 表1 路径参数 参数
则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于创建产品接口,您可以从接口的请求部分看到所需的请求参数及参数说明。
建立安全隧道的WebSocket连接 应用端 设备端 父主题: 安全隧道WebSocket接口参考
下发概述。 命令下发 为能有效地对设备进行管理,设备的产品模型中定义了物联网平台可向设备下发的命令,应用服务器可以调用物联网平台应用侧API接口向设备下发命令,以实现对设备的远程控制。详情请参见命令下发概述。 属性下发 属性下发分为查询设备属性和修改属性参数两种,查询设备属性用于
从控制台获取项目ID 在调用接口时,部分URI以及请求体中需要填入项目ID,项目ID获取步骤如下: 在华为云首页右上角,单击“控制台”。 在右上角的用户名中选择“我的凭证”。 在“我的凭证”界面,API凭证页签中,查看项目ID。 图1 API凭证-获取项目ID 调用API获取项目ID 项目
更新设备策略信息 功能介绍 应用服务器可调用此接口在物联网平台更新策略。 调用方法 请参见如何调用API。 URI PUT /v5/iot/{project_id}/device-policies/{policy_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
查询批量任务 功能介绍 应用服务器可调用此接口查询物联网平台中指定批量任务的信息,包括任务内容、任务状态、任务完成情况统计以及子任务列表等。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/batchtasks/{task_id} 表1
删除实例 功能介绍 删除设备接入实例。约束:此接口仅支持删除按需计费的实例。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/iotda-instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述
请求响应的状态,完整的状态码列表请参见状态码。 对于创建产品接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”等。 对于创建产品接口,平台会返回“Content-type”、Date等消息头。 响应消息体
获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,
修改设备接入实例的计费模式,支持将按需计费模式修改为包年/包月计费模式。 接口约束:当前实例的规格支持包年/包月计费模式时,才可以修改实例的计费模式为包年/包月。支持的实例规格请参见产品规格说明。 调用方法 请参见如何调用API。 URI POST /v5/iot/{project_id}/
查询设备策略详情 功能介绍 应用服务器可调用此接口在物联网平台查询指定策略ID的详细信息。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/device-policies/{policy_id} 表1 路径参数 参数 是否必选 参数类型
是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数
获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,
是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数
删除批量任务 功能介绍 应用服务器可调用此接口删除物联网平台中已经完成(状态为成功,失败,部分成功,已停止)的批量任务。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/batchtasks/{task_id} 表1 路径参数 参数
应用端 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
是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数
查询规则 功能介绍 应用服务器可调用此接口查询物联网平台中指定规则的配置信息。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/rules/{rule_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String