調用該接口查詢指定設備或IoT孿生節點的所有屬性快照。

使用說明

若查詢IoT孿生節點的屬性數據，必須傳入參數IotId，且取值為孿生節點ID。

QPS限制

單個阿里云賬號調用該接口的每秒請求數（QPS）最大限制為200。

說明 RAM用戶共享阿里云賬號配額。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 QueryDevicePropertyStatus

系統規定參數。取值：QueryDevicePropertyStatus。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

實例ID。您可在物聯網平臺控制臺的實例概覽頁面，查看當前實例的ID。

重要
  • 若有ID值，必須傳入該ID值，否則調用會失敗。
  • 若無實例概覽頁面或ID值，則無需傳入。

實例的更多信息，請參見實例概述。
ProductKey String 否 a1BwAGV****

要查詢的設備所屬的產品ProductKey。

重要

如果傳入該參數，需同時傳入DeviceName。
DeviceName String 否 light

要查詢的設備名稱。

重要

如果傳入該參數，需同時傳入ProductKey。
IotId String 否 Q7uOhVRdZRRlDnTLv****00100

要查詢屬性所屬的設備ID或IoT孿生節點ID：

  • 調用QueryDeviceInfo接口，可查詢指定設備的IotId。
  • 在物聯網平臺控制臺的孿生實體圖頁面，單擊孿生節點，可查看節點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

屬性格式類型，取值：

  • int：整型。
  • float：單精度浮點型。
  • double：雙精度浮點型。
  • enum：枚舉型。
  • bool：布爾型。
  • text：字符型。
  • date：時間型（String類型的UTC時間戳，單位是毫秒）。
  • array：數組型。
  • struct：結構體類型。
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

表示是否調用成功。

  • true：調用成功。
  • false：調用失敗。

示例

請求示例

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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。