调用该接口查询指定设备本身上报的原始属性(通过和未通过物模型校验的所有属性)记录。
使用说明
- 华东2(上海)、华北2(北京)和华南1(深圳)地域的标准型和尊享型企业版实例:仅可查询存储时效内的数据。数据存储时效,请参见存储配置。
- 其他地域和实例:仅可查询最近30天内的原始属性数据。
QPS限制
单阿里云账号调用该接口的每秒请求数(QPS)最大限制为50。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | QueryDeviceOriginalPropertyData |
系统规定参数。取值:QueryDeviceOriginalPropertyData。 |
Asc | Integer | 是 | 0 |
返回结果中,属性记录按时间排序的方式。取值:
说明 StartTime必须小于EndTime,系统会根据排序方式自动转换。
|
EndTime | Long | 是 | 1579249499000 |
属性记录的结束时间。取值为13位毫秒值时间戳。 |
Identifier | String | 是 | temperature |
属性的标识符。
|
PageSize | Integer | 是 | 10 |
单个属性可返回的数据记录数量。最大值为100。 任意一个属性返回的数据记录数量不超过该值。 |
StartTime | Long | 是 | 1569249488000 |
要查询的属性记录的开始时间。取值为毫秒值时间戳。 |
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** |
实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。 重要
实例的更多信息,请参见实例概述。 |
ProductKey | String | 否 | a1BwAGV**** |
要查询设备所属的产品ProductKey。 重要 如果传入该参数,需同时传入DeviceName。
|
DeviceName | String | 否 | light |
要查询的设备名称。 重要 如果传入该参数,需同时传入ProductKey。
|
NextPageToken | String | 否 | Bo***x44Qx |
下一页标识。如果存在下一页,服务会返回此token,下次请求带上即可。 |
IotId | String | 否 | Q7uOhVRdZRRlDnTLv****00100 |
要查询的设备ID。物联网平台为该设备颁发的ID,设备的唯一标识符。 重要 IotId作为设备唯一标识符,和ProductKey与DeviceName组合是一一对应的关系。如果传入该参数,则无需传入ProductKey和DeviceName。如果您同时传入IotId和ProductKey与DeviceName组合,则以IotId为准。
|
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | iot.device.InvalidIoTId |
调用失败时,返回的错误码。更多信息,请参见错误码。 |
Data | Struct |
调用成功时,返回的设备属性记录。 |
|
List | Array of PropertyInfo |
属性集合。每个元素代表一个属性。 |
|
PropertyInfo | |||
Time | String | 1516541885630 |
属性修改时间。 |
Value | String | 2 |
属性值。 |
NextValid | Boolean | true |
是否有下一页属性记录。
返回NextValid为true时,可以将NextPageToken的值作为下次查询的NextPageToken,继续查询本次查询不显示的数据。 |
nextPageToken | String | Bo***x44Qx |
下一页标识。 |
ErrorMessage | String | 系统异常 |
调用失败时,返回的出错信息。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 |
阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true |
是否调用成功。
|
示例
请求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceOriginalPropertyData
&Asc=0
&EndTime=1579249499000
&Identifier=temperature
&PageSize=10
&StartTime=1569249488000
&IotId=Q7uOhVRdZRRlDnTLv****00100
&<公共请求参数>
正常返回示例
XML
格式
<QueryDeviceOriginalPropertyDataResponse>
<Data>
<NextValid>false</NextValid>
<nextPageToken>Bo***x44Qx</nextPageToken>
<List>
<PropertyInfo>
<Value>32.46</Value>
<Time>1579249151178</Time>
</PropertyInfo>
</List>
</Data>
<RequestId>45391E10-446B-4986-863E-1BA8CC44748F</RequestId>
<Success>true</Success>
</QueryDeviceOriginalPropertyDataResponse>
JSON
格式
{
"Data": {
"NextValid": false,
"nextPageToken": "Bo***x44Qx",
"List": {
"PropertyInfo": [
{
"Value": "32.46",
"Time": 1579249151178
}
]
}
},
"RequestId": "45391E10-446B-4986-863E-1BA8CC44748F",
"Success": true
}
错误码
访问错误中心查看更多错误码。