全部產品
Search
文件中心

IoT Platform:SetDeviceGroupTags

更新時間:Feb 12, 2025

調用該介面添加、更新或刪除分組標籤。

使用說明

單個分組最多可有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由標籤的tagKeytagValue組成,tagKeytagValue均不可為空。

  • 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

分組類型。

無需傳入。

調用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
}

錯誤碼

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