調用該接口批量設置設備屬性值。
使用說明
物模型功能定義數(shù)據(jù)類型為float或double時,對應參數(shù)值(即使值為整數(shù))至少攜帶一位小數(shù)位。例如10.0、11.1。
QPS限制
單個阿里云賬號調用該接口的每秒請求數(shù)(QPS)最大限制為10。
說明 RAM用戶共享阿里云賬號配額。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | SetDevicesProperty | 系統(tǒng)規(guī)定參數(shù)。取值:SetDevicesProperty。 |
DeviceName.N | RepeatList | 是 | light | 要設置屬性值的設備名稱列表。設備名稱的個數(shù)范圍為1~100個。 |
Items | String | 是 | {"Switch":1,"Color":"blue"} | 要設置的屬性信息,數(shù)據(jù)格式為JSON。 每個屬性信息由標識符與屬性值(key:value)構成,多個屬性用英文逗號隔開。 例如,設置智能燈的兩個屬性:
那么要設置的屬性信息,JSON格式如下: Items={"Switch":1,"Color":"blue"}
說明 如果設置自定義模塊testFb(非默認模塊)的屬性,則格式為: Items={"testFb:Switch":1,"testFb:Color":"blue"} |
ProductKey | String | 是 | a1BwAGV**** | 要設置屬性值的設備所屬的產品ProductKey。 |
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 實例ID。您可在物聯(lián)網平臺控制臺的實例概覽頁面,查看當前實例的ID。 重要
實例的更多信息,請參見實例概述。 |
Qos | Integer | 否 | 1 | 指定調用本接口時,消息的發(fā)送方式。取值:
|
調用API時,除了本文介紹的該API的特有請求參數(shù),還需傳入公共請求參數(shù)。公共請求參數(shù)說明,請參見公共參數(shù)文檔。
返回數(shù)據(jù)
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
Code | String | iot.system.SystemException | 調用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼。 |
ErrorMessage | String | 系統(tǒng)異常 | 調用失敗時,返回的出錯信息。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | 阿里云為該請求生成的唯一標識符。 |
Success | Boolean | true | 表示是否調用成功。
|
示例
請求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=SetDevicesProperty
&DeviceName.1=1102andriod02
&DeviceName.2=1102android01
&Items=%7B%20%20%20%20%20%22Data%22%3A%221372060916%22%2C%20%20%20%20%20%22Status%22%3A1%20%7D
&ProductKey=a1hWjHD****
&<公共請求參數(shù)>
正常返回示例
XML
格式
<SetDevicesPropertyResponse>
<RequestId>2E19BDAF-0FD0-4608-9F41-82D230CFEE38</RequestId>
<Success>true</Success>
</SetDevicesPropertyResponse>
JSON
格式
{
"RequestId": "2E19BDAF-0FD0-4608-9F41-82D230CFEE38",
"Success": true
}