检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
获取项目ID 从控制台获取项目ID 在调用接口时,部分URI以及请求体中需要填入项目ID,项目ID获取步骤如下: 在华为云首页右上角,单击“控制台”。 在右上角的用户名中选择“我的凭证”。 在“我的凭证”界面,API凭证页签中,查看项目ID。 图1 API凭证-获取项目ID 调用API获取项目ID
unnel_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见 获取项目ID 。 tunnel_id 是 String 隧道ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
device_id String 设备ID,用于唯一标识一个设备,在注册设备时由物联网平台分配获得。 command_id String 设备命令ID,用于唯一标识一条命令,在下发设备命令时由物联网平台分配获得。 service_id String 设备命令所属的设备服务ID,在设备关联的产品模型中定义。
查询指定消息id的消息 功能介绍 应用服务器可调用此接口查询平台下发给设备的指定消息id的消息。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/devices/{device_id}/messages/{message_id} 表1 路径参数
更新指定id的预调配模板信息 功能介绍 应用服务器可调用此接口在物联网平台更新指定id的预调配模板。 调用方法 请参见如何调用API。 URI PUT /v5/iot/{project_id}/provisioning-templates/{template_id} 表1 路径参数
入。 选择左侧导航栏的“监控运维 > 远程配置”。 单击“新增远程配置”按钮,进入创建远程配置任务界面。 图1 远程配置-远程配置页面 在远程配置任务界面,输入任务名称,选择执行时间,配置超时时间和重试策略。 启用重试后,可以设置重启次数和重启间隔。重启次数建议设置为2次,重启间
更新指定id的自定义鉴权 功能介绍 应用服务器可调用此接口在物联网平台更新指定id的自定义鉴权。 调用方法 请参见如何调用API。 URI PUT /v5/iot/{project_id}/device-authorizers/{authorizer_id} 表1 路径参数 参数
物联网平台不会保存用户输入的用户名和密码,仅透传给设备。 图2 远程登录-选择设备 单击确定后,您将看到如下远程控制台页面,界面提示等待设备开启SSH功能。 图3 远程登录-等待设备开启SSH功能 登录成功后,您将看到如下远程控制台页面,您可根据设备本身功能对设备进行管理。 图4 远程登录-远程登录成功 父主题:
况。应用服务器可调用此接口向平台查询设备隧道建立情况。 该API接口在基础版不支持。 具体应用可见“设备远程登录”功能,请参见设备远程登录。 调用方法 请参见如何调用API。 URI GET /v5/iot/{project_id}/tunnels/{tunnel_id} 表1 路径参数
参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见 获取项目ID 。 表2 Query参数 参数 是否必选 参数类型 描述 device_id 否 String 参数说明:设备ID 请求参数 表3 请求Header参数 参数 是否必选
远程配置 平台下发配置通知 设备上报配置响应 父主题: 设备侧MQTT/MQTTS接口参考
物联网平台向设备侧下发配置通知。物联网平台为用户提供远程配置功能,用户可以在不中断设备运行的情况下,远程更新设备的系统参数、运行参数等配置信息。例如:Windows的收银台机器,需要通过远程配置修改一些系统参数;车联网中的T-BOX,需要通过远程配置修改设备侧的一些数据上报频率等。 Topic
$oc/devices/{device_id}/sys/events/up 参数说明 字段名 必选/可选 类型 参数描述 object_device_id 可选 String 参数解释: 网关设备上报时,子设备进行上报需填写该参数。object_device_id为Topic中设备的子设备Id,否则将请求失败。
具体应用可见“设备远程登录”功能,请参见设备远程登录。 调用方法 请参见如何调用API。 URI DELETE /v5/iot/{project_id}/tunnels/{tunnel_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
commands/request_id={request_id} 平台 设备 设备返回命令响应 $oc/devices/{device_id}/sys/commands/response/request_id={request_id} 设备 平台 设备属性相关Topic 设备上报属性数据
$oc/devices/{device_id}/sys/events/up 数据格式: { "object_device_id": "{object_device_id}", "services": [{ "service_id": "$ota",
String 参数说明:项目ID。获取方法请参见 获取项目ID 。 group_id 是 String 参数说明:设备组ID,用于唯一标识一个设备组,在创建设备组时由物联网平台分配。 取值范围:长度不超过36,十六进制字符串和连接符(-)的组合。 请求参数 表2 请求Header参数 参数
立与物联网平台的WebSocket连接,用户可以在应用端远程登录使用基于安全隧道建链的设备(远程SSH登录服务),进行设备的更新配置、排查诊断、运维变更等操作。 Topic 下行:$oc/devices/{device_id}/sys/events/down 参数说明 字段名 必选/可选
action_id String 规则动作ID,用于唯一标识一条规则动作,在创建规则动作时由物联网平台分配获得,创建时无需携带,由平台统一分配唯一的action_id。 rule_id String 规则动作对应的的规则触发条件ID。 app_id String 资源空间ID。 channel
s 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见 获取项目ID 。 device_id 是 String 参数说明:下发消息的设备ID,用于唯一标识一个设备,在注册设备时由物联网平台分配获得。 取值范围