全部產品
Search
文件中心

IoT Platform:SetDevicesProperty

更新時間:Feb 12, 2025

調用該介面大量設定裝置屬性值。

使用說明

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

QPS限制

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

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

調試

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

請求參數

名稱 類型 是否必選 樣本值 描述
Action String SetDevicesProperty

系統規定參數。取值:SetDevicesProperty。

DeviceName.N RepeatList light

要設定屬性值的裝置名稱列表。裝置名稱的個數範圍為1~100個。

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"}
ProductKey String a1BwAGV****

要設定屬性值的裝置所屬的產品ProductKey

IotInstanceId String iot_instc_pu****_c*-v64********

執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面,查看當前執行個體的ID

重要
  • 若有ID值,必須傳入該ID值,否則調用會失敗。
  • 若無執行個體概覽頁面或ID值,則無需傳入。

執行個體的更多資訊,請參見執行個體概述

Qos Integer 1

指定調用本介面時,訊息的發送方式。取值:

  • 0(預設):最多發送一次。
  • 1:最少發送一次。如果QoS=1訊息未接收到PUBACK訊息,會在裝置重連時,重新推送給裝置。

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

返回資料

名稱 類型 樣本值 描述
Code String iot.system.SystemException

調用失敗時,返回的錯誤碼。更多資訊,請參見錯誤碼

ErrorMessage String 系統異常

調用失敗時,返回的出錯資訊。

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里雲為該請求產生的唯一識別碼。

Success Boolean true

表示是否調用成功。

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

樣本

請求樣本

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****
&<公用請求參數>

正常返回樣本

XML格式

<SetDevicesPropertyResponse>
  <RequestId>2E19BDAF-0FD0-4608-9F41-82D230CFEE38</RequestId>
  <Success>true</Success>
</SetDevicesPropertyResponse>

JSON格式

{
  "RequestId": "2E19BDAF-0FD0-4608-9F41-82D230CFEE38",
  "Success": true
}

錯誤碼

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