調用該接口添加、更新或刪除分組標簽。

使用說明

單個分組最多可有100個標簽。

QPS限制

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

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

調試

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

請求參數

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

系統規定參數。取值：SetDeviceGroupTags。
GroupId String 是 W16X8Tvdosec****

分組ID，分組的全局唯一標識符。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

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

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

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

TagString String 否 [{"tagKey":"h1","tagValue":"rr"},{"tagKey":"7h","tagValue":"rr"}]

JSON格式的標簽數據。TagString由標簽的tagKey和tagValue組成，tagKey和tagValue均不能為空。

  • tagKey：標簽鍵?？砂⑽拇笮懽帜?，數字和英文句號（.），長度在2~30字符之間。
  • tagValue：標簽值?？砂形摹⒂⑽淖帜浮底帧⑾聞澗€（_）和短劃線（-）。長度不可超過128個字符。一個中文漢字算2個字符。

多個標簽以英文逗號間隔。例如[{"tagKey":"h1","tagValue":"rr"},{"tagKey":"7h","tagValue":"rr"}]。

若更新已有標簽，新的標簽Value值將覆蓋原來的值。

若要刪除某個標簽，則不傳入該標簽的Key和Value即可。

注意 abc為物聯網平臺系統保留的標簽Key，即tagKey不能設置為abc。若設置tagKey=abc，使用標簽檢索時會直接被過濾。
GroupType String 否 LINK_PLATFORM_DYNAMIC

分組類型。

傳入LINK_PLATFORM_DYNAMIC時，表示動態分組。不傳入時，默認為靜態分組。

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

返回數據

名稱 類型 示例值 描述
Code String iot.system.SystemException

調用失敗時，返回的錯誤碼。更多信息，請參見錯誤碼。

ErrorMessage String 系統異常

調用失敗時，返回的出錯信息。
RequestId String 12CFDAF1-99D9-42E0-8C2F-F281DA5E8953

阿里云為該請求生成的唯一標識符。
Success Boolean true

是否調用成功。

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

示例

請求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=SetDeviceGroupTags
&GroupId=W16X8Tvdosec****
&TagString=[{"tagKey":"h1","tagValue":"rr"},{"tagKey":"7h","tagValue":"rr"}]
&<公共請求參數>

正常返回示例

XML格式 

<SetDeviceGroupTagsResponse>
      <RequestId>12CFDAF1-99D9-42E0-8C2F-F281DA5E8953</RequestId>
      <Success>true</Success>
</SetDeviceGroupTagsResponse>

JSON格式 

{
    "RequestId":"12CFDAF1-99D9-42E0-8C2F-F281DA5E8953",
    "Success":true
}