調用介面QueryDevicePropertyData查詢指定裝置或IoT孿生節點,在指定時間段內,單個屬性的資料。
使用說明
若裝置或數字孿生節點有多個屬性,您可以多次調用本介面,一次輸入一個Identifier進行查詢,也可以直接調用介面QueryDevicePropertiesData,一次輸入多個Identifier進行查詢。
使用限制
- 標準型和尊享型企業版執行個體:僅可查詢儲存時效內的資料。資料存放區時效,請參見儲存配置。
- 其他執行個體:僅可查詢最近30天內的屬性資料。
QPS限制
單個阿里雲帳號調用該介面的每秒請求數(QPS)最大限制為50。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
|
名稱 |
類型 |
是否必選 |
樣本值 |
描述 |
| Action | String | 是 | QueryDevicePropertyData | 系統規定參數。取值:QueryDevicePropertyData。 |
| EndTime | Long | 是 | 1579249499000 | 要查詢的屬性記錄的結束時間,必須大於起始時間StartTime。取值為毫秒值時間戳記,例如:1579249499000。 |
| Asc | Integer | 是 | 0 | 返回結果中屬性記錄的排序方式,取值:
|
| Identifier | String | 是 | temperature | 要查詢的屬性標識符。 裝置的屬性Identifier,可在物聯網平台控制台中裝置所屬的產品的功能定義中查看,或調用QueryThingModel,從返回的物模型資料中查看。 說明 如果裝置的屬性是自訂(非預設)模組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: 調用QueryDeviceInfo介面,可查詢指定裝置的IotId。 重要 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
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。