查询设备属性 - ListProperties
功能介绍
设备的产品模型中定义了物联网平台可向设备下发的属性，应用服务器可调用此接口向设备发送指令用以查询设备的实时属性, 并由设备将属性查询的结果同步返回给应用服务器。
注意：此接口适用于MQTT设备，暂不支持NB-IoT设备。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
iotda:properties:query
Read
app *
-
-
-
-
g:EnterpriseProjectId
URI
GET /v5/iot/{project_id}/devices/{device_id}/properties
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| device_id | 是 | String | 参数说明：下发属性的设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。 取值范围：长度不超过128，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
| project_id | 是 | String | 参数说明：项目ID。获取方法请参见 获取项目ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| service_id | 是 | String | 参数说明：设备的服务ID，在设备关联的产品模型中定义。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Instance-Id | 否 | String | 参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考 查看实例详情。 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| request_id | String | 设备属性查询ID，用于唯一标识一条属性查询，在下发查询属性时由物联网平台分配获得。 |
| response | Object | 设备上报的属性执行结果。Json格式，具体格式需要应用和设备约定。 |
| error_code | String | 属性查询异常错误码。 |
| error_msg | String | 属性查询异常错误信息。 |
请求示例
查询设备属性，查询指定设备的服务为Temperature的所有属性。
GET https://{endpoint}/v5/iot/{project_id}/devices/{device_id}/properties?service_id=Temperature 响应示例
状态码：200
OK
{
"request_id" : "b1224afb-e9f0-4916-8220-b6bab568e888",
"response" : {
"services" : {
"serviceId" : "Temperature",
"properties" : {
"PhV_phsA" : "1",
"PhV_phsB" : "2"
},
"eventTime" : "20190606T121212Z"
}
},
"error_code" : "string",
"error_msg" : "string"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
| 503 | Service Unavailable |
错误码
请参见错误码。
