QueryDeviceDesiredProperty - IoT Platform

使用說明

唯讀屬性不支援查詢期望屬性值。
一次調用最多能查詢10個屬性的期望值。

QPS限制

單個阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為50。

說明 RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	QueryDeviceDesiredProperty	系統規定參數。取值：QueryDeviceDesiredProperty。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
ProductKey	String	否	a1BwAGV****	要查詢的裝置所隸屬的產品ProductKey。說明如果傳入該參數，需同時傳入DeviceName。
DeviceName	String	否	light	要查詢的裝置名稱。說明如果傳入該參數，需同時傳入ProductKey。
Identifier.N	RepeatList	否	Temperature	要查詢期望值的屬性的標識符（identifier）列表。裝置的屬性identifier，可在控制台中，裝置所屬產品的功能定義中查看。單次調用，最多能傳入10個標識符。不可輸入重複的屬性標識符。若不傳入此參數，將返回該裝置所有屬性的期望值。
IotId	String	否	Q7uOhVRdZRRlDnTLv****00100	裝置ID。物聯網平台為該裝置頒發的ID，裝置的唯一識別碼。說明如果傳入該參數，則無需傳入ProductKey和DeviceName。IotId作為裝置唯一識別碼，和ProductKey與DeviceName組合是一一對應的關係。如果您同時傳入IotId和ProductKey與DeviceName組合，則以IotId為準。
FunctionBlockId	String	否	BatteryModule	物模型自訂模組標識符，在產品中具有唯一性。不傳入此參數時，查詢預設模組的資料。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公用請求參數。公用請求參數說明，請參見公用參數文檔。

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Struct		調用成功時，返回的資料（List）。
List	Array of DesiredPropertyInfo		返回的期望屬性資訊（DesiredPropertyInfo）。
DesiredPropertyInfo
DataType	String	int	屬性資料類型。
Identifier	String	Temperature	屬性標識符。
Name	String	airconditioning	屬性名稱。
Time	String	1579335899000	期望屬性值的修改時間，單位是毫秒。
Unit	String	℃	屬性單位。
Value	String	34	期望屬性值。說明如果已調用ClearDeviceDesiredProperty介面清空對應屬性的期望值，則不會返回參數Value。
Version	Long	1	當前期望屬性值的版本號碼。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceDesiredProperty
&IotId=SR8FiTu1R9tlUR2****0010300
&Identifier.1=Weight
&Identifier.2=Circle
&<公用請求參數>

正常返回樣本

XML格式

<QueryDeviceDesiredPropertyResponse>
  <Data>
        <List>
              <DesiredPropertyInfo>
                    <Name>溫度</Name>
                    <Value>35</Value>
                    <Time>1581778567154</Time>
                    <DataType>float</DataType>
                    <Version>1</Version>
                    <Identifier>Temperature</Identifier>
                    <Unit>°C</Unit>
              </DesiredPropertyInfo>
        </List>
  </Data>
  <RequestId>F0B1F7C8-A799-44C3-BDF8-1B8F9E91E675</RequestId>
  <Success>true</Success>
</QueryDeviceDesiredPropertyResponse>

JSON格式

{
  "Data": {
    "List": {
      "DesiredPropertyInfo": [
        {
          "Name": "溫度", 
          "Value": "35", 
          "Time": "1581778567154", 
          "DataType": "float", 
          "Version": 1, 
          "Identifier": "Temperature", 
          "Unit": "°C"
        }
      ]
    }
  }, 
  "RequestId": "F0B1F7C8-A799-44C3-BDF8-1B8F9E91E675", 
  "Success": true
}

錯誤碼

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