調(diào)用該接口查詢指定設(shè)備的期望屬性值。

使用說明

  • 只讀屬性不支持查詢期望屬性值。
  • 一次調(diào)用最多能查詢10個屬性的期望值。

QPS限制

單個阿里云賬號調(diào)用該接口的每秒請求數(shù)（QPS）最大限制為50。

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

調(diào)試

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

請求參數(shù)

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

系統(tǒng)規(guī)定參數(shù)。取值：QueryDeviceDesiredProperty。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

實例ID。您可在物聯(lián)網(wǎng)平臺控制臺的實例概覽頁面，查看當前實例的ID。

重要
  • 若有ID值，必須傳入該ID值，否則調(diào)用會失敗。
  • 若無ID值，則無需傳入。

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

要查詢的設(shè)備所隸屬的產(chǎn)品ProductKey。

說明 如果傳入該參數(shù)，需同時傳入 DeviceName。
DeviceName String 否 light

要查詢的設(shè)備名稱。

說明 如果傳入該參數(shù)，需同時傳入 ProductKey。
Identifier.N RepeatList 否 Temperature

要查詢期望值的屬性的標識符（identifier）列表。

設(shè)備的屬性identifier，可在控制臺中，設(shè)備所屬產(chǎn)品的功能定義中查看。

  • 單次調(diào)用，最多能傳入10個標識符。
  • 不可輸入重復(fù)的屬性標識符。
  • 若不傳入此參數(shù)，將返回該設(shè)備所有屬性的期望值。
IotId String 否 Q7uOhVRdZRRlDnTLv****00100

設(shè)備ID。物聯(lián)網(wǎng)平臺為該設(shè)備頒發(fā)的ID，設(shè)備的唯一標識符。

說明 如果傳入該參數(shù)，則無需傳入 ProductKey和 DeviceName。 IotId作為設(shè)備唯一標識符，和 ProductKey與 DeviceName組合是一一對應(yīng)的關(guān)系。如果您同時傳入 IotId和 ProductKey與 DeviceName組合，則以 IotId為準。
FunctionBlockId String 否 BatteryModule

物模型自定義模塊標識符，在產(chǎn)品中具有唯一性。

不傳入此參數(shù)時，查詢默認模塊的數(shù)據(jù)。

調(diào)用API時，除了本文介紹的該API的特有請求參數(shù)，還需傳入公共請求參數(shù)。公共請求參數(shù)說明，請參見公共參數(shù)文檔。

返回數(shù)據(jù)

名稱 類型 示例值 描述
Code String iot.system.SystemException

調(diào)用失敗時，返回的錯誤碼。更多信息，請參見錯誤碼。
Data Struct

調(diào)用成功時，返回的數(shù)據(jù)（List）。
List Array of DesiredPropertyInfo

返回的期望屬性信息（DesiredPropertyInfo）。
DesiredPropertyInfo
DataType String int

屬性數(shù)據(jù)類型。
Identifier String Temperature

屬性標識符。
Name String airconditioning

屬性名稱。
Time String 1579335899000

期望屬性值的修改時間，單位是毫秒。
Unit String ℃

屬性單位。
Value String 34

期望屬性值。

說明 如果已調(diào)用 ClearDeviceDesiredProperty接口清空對應(yīng)屬性的期望值，則不會返回參數(shù) Value。
Version Long 1

當前期望屬性值的版本號。
ErrorMessage String 系統(tǒng)異常

調(diào)用失敗時，返回的出錯信息。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云為該請求生成的唯一標識符。
Success Boolean true

表示是否調(diào)用成功。

  • true：調(diào)用成功。
  • false：調(diào)用失敗。

示例

請求示例

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

正常返回示例

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
}

錯誤碼

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