调用接口QueryDevicePropertyData查询指定设备或IoT孪生节点,在指定时间段内,单个属性的数据。
使用说明
- 若设备或数字孪生节点有多个属性,您可以多次调用本接口,一次输入一个Identifier进行查询,也可以直接调用接口QueryDevicePropertiesData,一次输入多个Identifier进行查询。
- 若查询数字孪生节点的属性数据,必须传入参数IotId,且取值为孪生节点ID。
使用限制
- 标准型和尊享型企业版实例:仅可查询存储时效内的数据。数据存储时效,请参见存储配置。
- 其他实例:仅可查询最近30天内的属性数据。
QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为50。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | QueryDevicePropertyData | 系统规定参数。取值:QueryDevicePropertyData。 |
EndTime | Long | 是 | 1579249499000 | 要查询的属性记录的结束时间,必须大于起始时间StartTime。取值为毫秒值时间戳,例如:1579249499000。 |
Asc | Integer | 是 | 0 | 返回结果中属性记录的排序方式,取值:
|
Identifier | String | 是 | temperature | 要查询的属性标识符。
说明 如果设备的属性是自定义(非默认)模块testFb下属性temperature,则参数值为testFb:temperature。 |
PageSize | Integer | 是 | 10 | 返回结果中每页显示的记录数。数量限制:每页最多可显示50条。 |
StartTime | Long | 是 | 1579249499000 | 要查询的属性记录的开始时间,必须小于结束时间EndTime。取值为毫秒值时间戳,例如:1579249499000。 |
IotInstanceId | String | 否 | iot-cn-0pp1n8t**** | 实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。 重要
实例的更多信息,请参见实例概述。 |
IotId | String | 否 | Q7uOhVRdZRRlDnTLv****00100 | 要查询属性所属的设备ID或数字孪生节点ID:
重要 IotId作为设备唯一标识符,和ProductKey与DeviceName组合是一一对应的关系。如果传入该参数,则无需传入ProductKey和DeviceName。如果您同时传入IotId和ProductKey与DeviceName组合,则以IotId为准。
|
ProductKey | String | 否 | a1BwAGV**** | 要查询设备所属的产品ProductKey。 重要
如果传入该参数,需同时传入DeviceName。 |
DeviceName | String | 否 | airconditioning | 要查询设备的名称。 重要
如果传入该参数,需同时传入ProductKey。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 |
类型 |
示例值 |
描述 |
Code | String | iot.system.SystemException | 调用失败时,返回的错误码。更多信息,请参见错误码。 |
Data | Struct | 调用成功时,返回的设备属性记录。 |
|
List | Array of PropertyInfo | 属性数据列表。 |
|
PropertyInfo | |||
Time | String | 1516541885630 | 属性修改时间。 |
Value | String | 2 | 属性值。 |
NextTime | Long | 1579249499000 | 下一页面中的属性记录的起始时间。
|
NextValid | Boolean | true | 是否有下一页属性记录。
|
ErrorMessage | String | 系统异常 | 调用失败时,返回的出错信息。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | 阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true | 表示是否调用成功。
|
示例
请求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDevicePropertyData
&ProductKey=a1BwAGV****
&DeviceName=device1
&Identifier=lightLevel
&StartTime=1516538300303
&EndTime=1516541900303
&PageSize=10
&Asc=1
&<公共请求参数>
正常返回示例
XML
格式
<QueryDevicePropertyDataResponse>
<Data>
<NextValid>false</NextValid>
<NextTime>1579249151177</NextTime>
<List>
<PropertyInfo>
<Value>32.46</Value>
<Time>1579249151178</Time>
</PropertyInfo>
</List>
</Data>
<RequestId>45391E10-446B-4986-863E-1BA8CC44748F</RequestId>
<Success>true</Success>
</QueryDevicePropertyDataResponse>
JSON
格式
{
"Data": {
"NextValid": false,
"NextTime": 1579249151177,
"List": {
"PropertyInfo": [
{
"Value": "32.46",
"Time": 1579249151178
}
]
}
},
"RequestId": "45391E10-446B-4986-863E-1BA8CC44748F",
"Success": true
}