查询设备属性

Internal server

error. 服务器内部错误 请联系华为工程师

分析解决。

IOTDA .00002 0

Decrypt IAM token

failed. IAM Token解析失 败

请联系华为工程师 分析解决。

1.8 设备属性

设备的产品模型中定义了物联网平台可向设备下发的属性，设备属性为应用服务器提 供向设备下发属性的功能。

1.8.1 查询设备属性

接口说明

设备的产品模型中定义了物联网平台可向设备下发的属性，应用服务器可调用此接口 向设备发送指令用以查询设备的实时属性, 并由设备将属性查询的结果同步返回给应用 服务器。注意：此接口适用于MQTT设备，暂不支持NB-IoT设备。

调试

您可以在API Explorer中调试该接口。

URI

请求方法 GET

URI /v5/iot/{project_id}/devices/{device_id}/properties 传输协议 HTTPS

请求参数

名称 必选/可

选

类型 位置 说明

X-Auth-Token 必选 String Head

er 参数说明：用户Token。通过调用 IAM服务 获取IAM用户Token接口 获取，接口返回的响应消息头中

“X-Subject-Token”就是需要获 取的用户Token。简要的获取方法 样例请参见 Token认证。

Instance-Id 可选 String Head

er 参数说明：实例ID。物理多租下各 实例的唯一标识，一般华为云租户 无需携带该参数，仅在物理多租场 景下从管理面访问API时需要携带 该参数。

device_id 必选 String Path 参数说明：下发属性的设备ID，用 于唯一标识一个设备，在注册设备 时由物联网平台分配获得。

取值范围：长度不超过128，只允 许字母、数字、下划线（_）、连 接符（-）的组合。

project_i

d 必选 String Path 参数说明：项目ID。获取方法请参 见 获取项目ID。

service_id 必选 String Quer

y 参数说明：设备的服务ID，在设备 关联的产品模型中定义。

响应参数

名称 类型 说明

response Object 设备上报的属性执行结果。Json格式，具体格式 需要应用和设备约定。

请求示例

GET https://{Endpoint}/v5/iot/{project_id}/devices/{device_id}/properties?service_id={service_id}

Content-Type: application/json X-Auth-Token: ********

Instance-Id: ********

响应示例

Status Code: 200 OK

Content-Type: application/json { "response" : {

"services" : {

"serviceId" : "Temperature", "properties" : {

"PhV_phsA" : "1", "PhV_phsB" : "2"

},

"eventTime" : "20190606T121212Z"

}

400 IOTDA .01411 2

Send to device failed, device not subscribe topic.

发送到设备失败，

设备没有订阅该主 题

请确认设备是否订 阅正确的topic。

403 IOTDA .00002 1

Operation not allowed. User not found by IAM token or the authorized user has not subscribed IOTDA service.

没有找到IAM Token所对应的用户 信息或该用户没有 订阅设备接入服务

（IOTDA）

请排查IAM Token 所在用户是否订阅

Operation not allowed. The user does not have the permission

Operation not allowed.

Application not found by

authorized user or the authorized user has no application.

Operation not allowed. The device is not online.

Operation not allowed. The device has been frozen, can not be operated.

设备已被冻结，不 允许操作

请将设备解冻后再 重试。

404 IOTDA

. The device does

not exist. 设备不存在 请排查请求参数是 否有误并确认是否

HTTP 状态码

错误码 错误码英文描述 错误码中文描述 处理建议

IOTDA .01410 3

The device command does not exist.

设备命令不存在 请确认请求参数是 否正确。

500 IOTDA .00000