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