調用該介面查詢指定裝置或數字孿生節點,在指定時間段內,多個屬性的資料。
使用說明
目前本介面已不支援分頁查詢。調用本介面時,如果在指定時間段內,沒有返回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。 裝置的屬性Identifier,可在物聯網平台控制台中裝置所屬的產品的功能定義中查看,或調用QueryThingModel,從返回的物模型資料中查看。 說明 如果裝置的屬性是自訂(非預設)模組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: 調用QueryDeviceInfo介面,可查詢指定裝置的IotId。 重要 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
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。