調用該接口為指定設備批量設置期望屬性值。

使用說明

  • 只讀屬性不支持設置期望屬性值。
  • 一次調用最多可設置10個期望屬性值。
  • 設備創建后，期望屬性值的版本（Version）為0。首次設置期望屬性值時，如果指定Version參數，則需指定Version值為0。
重要 物模型功能定義數據類型為float或double時，對應參數值（即使值為整數）至少攜帶一位小數位。例如10.0、11.1。

QPS限制

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

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

調試

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

請求參數

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

系統規定參數。取值：SetDeviceDesiredProperty。
Items String 是 {"Temperature":35}

要設置的期望屬性值，組成為屬性的Key:Value，數據格式為JSON String，例如{"Temperature":35}。最多可輸入10個期望屬性值。

  • Key取值為屬性的標識符（identifier）?？稍诳刂婆_中，設備所屬產品的功能定義中查看；或調用QueryThingModel，從返回的物模型數據中查看。

    如果是自定義（非默認）模塊testFb下屬性temperature，則參數值為{"testFb:temperature":35}。
    說明 指定屬性必須是讀寫型。如果您指定了一個只讀型的屬性，設置將會失敗。并且， 一次調用中，不能傳入重復的屬性標識符。
  • Value取值為要設置的期望屬性值。取值需符合您為該屬性定義的數據類型和取值范圍。
    說明 若屬性值設置為null，則表示清空期望屬性值。
Versions String 是 {"Temperature":2}

當前期望屬性值版本，組成為Key:Value，數據格式為JSON String，例如{"Temperature":2}。

  • Key取值為屬性的標識符（identifier）。可在控制臺中，設備所屬產品的功能定義中查看屬性的identifier。
    說明 一次調用中，key的取值（即屬性的identifier）不能重復。

  • Value取值為當前期望屬性值的版本號。

    首次設置期望屬性值時，指定該參數值為0。首次設置期望屬性值后，期望值版本號為1。以后每次設置期望值后，物聯網平臺自動將期望值版本加1（即第二次設置期望屬性值時，指定該參數值為1。設置成功后，版本號自動變為2；第三次設置時，指定該參數值為2。設置成功后，版本號自動變為3；以此類推）。
    說明 如果傳入的版本號與當前版本不符，服務器將拒絕此次請求。若您不確定當前期望值的版本號，可以不傳入版本號，但仍需傳入有效的JSON，即傳入{}。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

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

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

實例的更多信息，請參見實例概述。

IotId String 否 Q7uOhVRdZRRlDnTLv****00100

要設置期望屬性值的設備ID。物聯網平臺為該設備頒發的ID，設備的唯一標識符。

重要 IotId作為設備唯一標識符，和ProductKey與DeviceName組合是一一對應的關系。如果傳入該參數，則無需傳入ProductKey和DeviceName。如果您同時傳入IotId和ProductKey與DeviceName組合，則以IotId為準。
DeviceName String 否 light

要設置期望屬性值的設備名稱。

重要 如果傳入該參數，需同時傳入ProductKey。
ProductKey String 否 a1BwAGV****

要設置期望屬性值的設備所隸屬的產品ProductKey。

重要 如果傳入該參數，需同時傳入DeviceName。

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

返回數據

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

調用失敗時，返回的錯誤碼。更多信息，請參見錯誤碼。

Data Struct

調用成功時，返回的數據。詳情請參見以下參數。
MessageId String 300511751

云端下發給設備的設置期望屬性值的消息ID。
Versions String {\"Temperature\":2}

本次設置期望屬性值后，期望屬性值的當前版本號。
ErrorMessage String 系統異常

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

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

是否調用成功。

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

示例

請求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=SetDeviceDesiredProperty
&ProductKey=a1BwAGV****
&DeviceName=device1
&Items=%7B%22LightAdjustLevel%22%3A1%7D
&Versions=%7B%22LightAdjustLevel%22%3A10%7D
&<公共請求參數>

正常返回示例

XML格式 

<SetDeviceDesiredPropertyResponse>
  <Data>
        <MessageId>300511751</MessageId>
        <Versions>{"LightAdjustLevel":2}</Versions>
  </Data>
  <RequestId>AADE79D2-B328-4FC6-A3E0-34BB23BCA440</RequestId>
  <Success>true</Success>
</SetDeviceDesiredPropertyResponse>

JSON格式 

{
    "Data": {
        "MessageId": "300511751",
        "Versions": "{\"LightAdjustLeve\":2}"
    },
    "RequestId": "AADE79D2-B328-4FC6-A3E0-34BB23BCA440",
    "Success": true
}

錯誤碼

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