UpdateDeviceShadow - IoT Platform

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
}

錯誤碼

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