調用該接口修改指定設備的影子信息。

QPS限制

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

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

調試

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

請求參數

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

系統規定參數。取值：UpdateDeviceShadow。
DeviceName String 是 device1

要修改影子信息的設備名稱。
ProductKey String 是 a1T27vz****

要修改影子信息的設備所隸屬的產品ProductKey。
ShadowMessage String 是 {"method":"update","state":{"desired":{"color":"green"}},"version":2}

修改后的設備影子信息。

影子信息參數中包含：

  • method：String，指定操作類型，取值：update。
  • state：String，發送給影子的具體狀態，由desired參數表示期望的影子狀態。
  • version：Long，設備影子的版本。
    • 若無需版本控制，該值設置為0。
    • 若需要版本控制，該值必須大于當前影子版本。
重要 需要版本控制時，不能直接從物聯網平臺查詢當前影子版本。因為更新和查詢操作并發量高時，可能導致多個更新操作查詢到同一個影子版本。基于此情況，最后一次發起的更新操作可能先完成，進而導致最終更新的影子信息不是最新的影子信息。所以，建議您本地維護影子版本，調用本接口時，從本地應用獲取最新影子版本。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

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

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

實例的更多信息，請參見實例概述。
DeltaUpdate Boolean 否 false

是否增量更新設備影子desired參數。

  • true：增量更新。
  • false（默認）：全量更新。

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

返回數據

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

調用失敗時，返回的錯誤碼。更多信息，請參見錯誤碼。
ErrorMessage String 系統異常

調用失敗時，返回的出錯信息。
RequestId String 6754C0E7-A35D-4CC8-A684-45EB1F0008D9

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

是否調用成功。

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

示例

請求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateDeviceShadow
&ProductKey=a1T27vz****
&DeviceName=device1
&ShadowMessage={"method":"update","state":{"desired":{"color":"green"}},"version":1}
&<公共請求參數>

正常返回示例

XML格式

<UpdateDeviceShadowResponse>
        <RequestId>BB71E443-4447-4024-A000-EDE09922891E</RequestId>
        <Success>true</Success>
  </UpdateDeviceShadowResponse>

JSON格式

{
	"RequestId": "6754C0E7-A35D-4CC8-A684-45EB1F0008D9",
	"Success": true
}

錯誤碼

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