調用該介面查詢指定裝置或IoT孿生節點的所有屬性快照。
使用說明
若查詢IoT孿生節點的屬性資料,必須傳入參數IotId,且取值為孿生節點ID。
QPS限制
單個阿里雲帳號調用該介面的每秒請求數(QPS)最大限制為200。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
| 名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
| Action | String | 是 | QueryDevicePropertyStatus | 系統規定參數。取值:QueryDevicePropertyStatus。 |
| IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面,查看當前執行個體的ID。 重要
執行個體的更多資訊,請參見執行個體概述。 |
| ProductKey | String | 否 | a1BwAGV**** | 要查詢的裝置所屬的產品ProductKey。 重要 如果傳入該參數,需同時傳入DeviceName。 |
| DeviceName | String | 否 | light | 要查詢的裝置名稱。 重要 如果傳入該參數,需同時傳入ProductKey。 |
| IotId | String | 否 | Q7uOhVRdZRRlDnTLv****00100 | 要查詢屬性所屬的裝置ID或IoT孿生節點ID:
重要 IotId作為裝置唯一識別碼,和ProductKey與DeviceName組合是一一對應的關係。如果傳入該參數,則無需傳入ProductKey和DeviceName。如果您同時傳入IotId和ProductKey與DeviceName組合,則以IotId為準。 |
| FunctionBlockId | String | 否 | BatteryModule | 物模型自訂模組標識符,在產品中具有唯一性。 不傳入此參數時,查詢預設模組的資料。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公用請求參數。公用請求參數說明,請參見公用參數文檔。
返回資料
| 名稱 | 類型 | 樣本值 | 描述 |
| Code | String | iot.system.SystemException | 調用失敗時,返回的錯誤碼。更多資訊,請參見錯誤碼。 |
| Data | Struct | 調用成功時,返回的資料,詳情請參見List包含的參數。 |
|
| List | Array of PropertyStatusInfo | 返回的屬性集合資訊(PropertyStatusInfo)。 |
|
| PropertyStatusInfo | |||
| DataType | String | int | 屬性格式類型,取值:
|
| Identifier | String | Temperature | 屬性標識符。 |
| Name | String | temperature | 屬性名稱。 |
| Time | String | 1517553572362 | 屬性修改的時間,單位是毫秒。 |
| Unit | String | °C | 屬性值的單位。 |
| Value | String | 25 | 屬性值。 |
| ErrorMessage | String | 系統異常 | 調用失敗時,返回的出錯資訊。 |
| RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | 阿里雲為該請求產生的唯一識別碼。 |
| Success | Boolean | true | 表示是否調用成功。
|
樣本
請求樣本
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDevicePropertyStatus
&ProductKey=a1rYuVF****
&DeviceName=device1
&<公用請求參數>
正常返回樣本
XML格式
<QueryDevicePropertyStatusResponse>
<Data>
<List>
<PropertyStatusInfo>
<Name>濕度</Name>
<Value>48</Value>
<Time>1579249151178</Time>
<DataType>int</DataType>
<Identifier>Humidity</Identifier>
<Unit>%</Unit>
</PropertyStatusInfo>
<PropertyStatusInfo>
<Name>溫度</Name>
<Value>32.46</Value>
<Time>1579249151178</Time>
<DataType>float</DataType>
<Identifier>Temperature</Identifier>
<Unit>°C</Unit>
</PropertyStatusInfo>
</List>
</Data>
<RequestId>84BAD25B-9879-4BA1-9213-F576C6558D77</RequestId>
<Success>true</Success>
</QueryDevicePropertyStatusResponse>
JSON格式
{
"Data": {
"List": {
"PropertyStatusInfo": [
{
"Name": "濕度",
"Value": "48",
"Time": "1579249151178",
"DataType": "int",
"Identifier": "Humidity",
"Unit": "%"
},
{
"Name": "溫度",
"Value": "32.46",
"Time": "1579249151178",
"DataType": "float",
"Identifier": "Temperature",
"Unit": "°C"
}
]
}
},
"RequestId": "84BAD25B-9879-4BA1-9213-F576C6558D77",
"Success": true
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。