調用該接口為指定設備設置標簽。

使用說明

  • 單個設備的設備標簽總數不超過100個。
  • 單次修改或新增的設備標簽數不超過100個。

QPS限制

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

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

調試

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

請求參數

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

系統規定參數。取值：SaveDeviceProp。
Props String 是 {"color":"red"}

要設置的設備標簽，支持設置多個標簽。

設備標簽是JSON格式，每個標簽的具體結構為：Key:Value。Key是標簽名稱，Value是對應的標簽值。

多個標簽使用半角逗號隔開，例如Props={"color":"red","shape":"round"}。

注意
  • Props的總大小不超過5 KB。
  • abc為物聯網平臺系統保留的標簽Key，即標簽Key不能設置為abc。若設置Key=abc，使用標簽檢索時會直接被過濾。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

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

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

實例的更多信息，請參見實例概述。

ProductKey String 否 a1BwAGV****

設備所屬的產品ProductKey。

說明 如果傳入該參數，需同時傳入DeviceName。
DeviceName String 否 light

設備名稱。

說明 如果傳入該參數，需同時傳入ProductKey。
IotId String 否 Q7uOhVRdZRRlDnTLv****00100

設備ID。物聯網平臺為該設備頒發的ID，設備的唯一標識符。

說明 如果傳入該參數，則無需傳入ProductKey和DeviceName。IotId作為設備唯一標識符，和ProductKey與DeviceName組合是一一對應的關系。如果您同時傳入IotId和ProductKey與DeviceName組合，則以IotId為準。

調用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=SaveDeviceProp
&ProductKey=a1BwAGV****
&DeviceName=device1
&Props=%7B%22color%22%3A%22red%22%7D
&<公共請求參數>

正常返回示例

XML格式 

<SaveDevicePropResponse>
  <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
  <Success>true</Success>
</SaveDevicePropResponse>

JSON格式 

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