SetDeviceProperty - IoT Platform

使用說明

因為雲端下發屬性設定命令和裝置收到並執行該命令是非同步，所以調用該介面時，返回的成功結果只表示雲端下發屬性設定的請求成功，不能保證裝置端收到並執行了該請求。即需裝置端SDK成功響應雲端設定裝置屬性值的請求，裝置屬性值才能真正設定成功。

重要物模型功能定義資料類型為float或double時，對應參數值（即使值為整數）至少攜帶一位小數位。例如10.0、11.1。

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	SetDeviceProperty	系統規定參數。取值：SetDeviceProperty。
Items	String	是	{"Switch":1,"Color":"blue"}	要設定的屬性資訊，資料格式為JSON。每個屬性資訊由標識符與屬性值（key:value）構成，多個屬性用英文逗號隔開。例如，設定智能燈的如下兩個屬性：標識符為Switch的開關屬性，資料類型為Bool，設定值為1（開）。標識符為Color的燈顏色屬性，資料類型為String，設定值為blue。那麼要設定的屬性資訊，JSON格式如下： `Items={"Switch":1,"Color":"blue"}` 說明如果設定自訂模組testFb（非預設模組）的屬性，則格式為：`Items={"testFb:Switch":1,"testFb:Color":"blue"}`
IotInstanceId	String	否	iot-v64*****	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
ProductKey	String	否	a1BwAGV****	裝置所屬的產品ProductKey。重要如果傳入該參數，需同時傳入DeviceName。
DeviceName	String	否	light	裝置名稱。重要如果傳入該參數，需同時傳入ProductKey。
IotId	String	否	Q7uOhVRdZRRlDnTLv****00100	裝置ID。物聯網平台為該裝置頒發的ID，裝置的唯一識別碼。重要 IotId作為裝置唯一識別碼，和ProductKey與DeviceName組合是一一對應的關係。如果傳入該參數，則無需傳入ProductKey和DeviceName。如果您同時傳入IotId和ProductKey與DeviceName組合，則以IotId為準。
Qos	Integer	否	1	指定調用本介面時，訊息的發送方式。取值： 0（預設）：最多發送一次。 1：最少發送一次。如果QoS=1訊息未接收到PUBACK訊息，會在裝置重連時，重新推送給裝置。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Struct		調用成功時，返回的資料。
MessageId	String	abcabc123	雲端給裝置下發屬性設定的訊息ID。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=SetDeviceProperty
&ProductKey=a1BwAGV****
&DeviceName=device1
&Items={"Switch":1,"Color":"blue"}
&<公用請求參數>

正常返回樣本

XML格式

<SetDevicePropertyResponse>
  <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
  <Success>true</Success>
  <Data>
        <MessageId>abcabc123</MessageId>
  </Data>
</SetDevicePropertyResponse>

JSON格式

{ 
  "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207", 
  "Success": true, 
  "Data": {
     "MessageId":"abcabc123"
   } 
}

錯誤碼

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