全部產品
Search
文件中心

IoT Platform:QueryDeviceGroupTagList

更新時間:Feb 12, 2025

調用該介面查詢分組標籤列表。

QPS限制

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

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

調試

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

請求參數

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

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

GroupId String 是 W16X8Tvdosec****

分組ID,分組的通用唯一識別碼。

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

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

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

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

GroupType String 否 LINK_PLATFORM_DYNAMIC

分組類型。

傳入LINK_PLATFORM_DYNAMIC時,表示動態分組。不傳入時,預設為靜態分組。

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

返回資料

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

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

Data Array of GroupTagInfo

調用成功時,返回的標籤資訊。請參見以下GroupTagInfo。

GroupTagInfo
TagKey String room1

標籤鍵。

TagValue String bulb

標籤值。

ErrorMessage String 系統異常

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

RequestId String 214154FF-9D47-4E3F-AAAD-F4CE67F41060

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

Success Boolean true

是否調用成功。

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

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceGroupTagList
&GroupId=W16X8Tvdosec****
&<公用請求參數>

正常返回樣本

XML格式

<QueryDeviceGroupTagListResponse>
      <Data>
            <GroupTagInfo>
                  <TagValue>bulb</TagValue>
                  <TagKey>room1</TagKey>
            </GroupTagInfo>
      </Data>
      <RequestId>214154FF-9D47-4E3F-AAAD-F4CE67F41060</RequestId>
      <Success>true</Success>
</QueryDeviceGroupTagListResponse>

JSON格式

{
    "Data":{
        "GroupTagInfo":[
            {
                "TagValue":"bulb",
                "TagKey":"room1"
            }
        ]
    },
    "RequestId":"214154FF-9D47-4E3F-AAAD-F4CE67F41060",
    "Success":true
}

錯誤碼

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