調用接口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
}