調用該接口查詢分組詳情。

QPS限制

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

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

調試

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

請求參數

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

系統規定參數。取值：QueryDeviceGroupInfo。
GroupId String 是 tDQvBJqbUyHs****

分組ID，分組的全局唯一標識符。

您可調用QueryDeviceGroupList接口查詢分組ID（GroupId）。
IotInstanceId String 否 iot-cn-0pp1n8t****

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

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

實例的更多信息，請參見實例概述。
GroupType String 否 LINK_PLATFORM_DYNAMIC

分組類型。

目前僅支持傳入LINK_PLATFORM_DYNAMIC，表示動態分組。不傳入時，默認為靜態分組。

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

返回數據

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

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

調用成功時，返回的分組詳細信息數據，包含以下參數。
DeviceActive Integer 1

激活設備數量。
DeviceCount Integer 10

設備總數。
DeviceOnline Integer 0

在線設備數量。
DynamicGroupExpression String product_key = "a1***" and name LIKE "test%"

動態分組規則，僅動態分組返回該參數信息。
GroupDesc String usefulGroup

分組描述。
GroupId String tDQvBJqbUyHs****

分組ID。
GroupName String aliyun

分組名稱。
UtcCreate String 2018-09-14T14:35:51.000Z

創建時間。
ErrorMessage String 系統異常

調用失敗時，返回的出錯信息。
RequestId String 7411716B-A488-4EEB-9AA0-6DB05AD2491F

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

表示是否調用成功。

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

示例

請求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceGroupInfo
&GroupId=tDQvBJqbUyHs****
&<公共請求參數>

正常返回示例

XML格式

<QueryDeviceGroupInfoResponse>
  <RequestId>7411716B-A488-4EEB-9AA0-6DB05AD2491F</RequestId>
  <Data>
        <GroupName>aliyun</GroupName>
        <UtcCreate>2021-10-14T14:35:51.000Z</UtcCreate>
        <DeviceOnline>0</DeviceOnline>
        <GroupDesc>usefulGroup</GroupDesc>
        <DeviceActive>1</DeviceActive>
        <DynamicGroupExpression>product_key = "a1***" and name LIKE "test%"</DynamicGroupExpression>
        <DeviceCount>10</DeviceCount>
        <GroupId>tDQvBJqbUyHs****</GroupId>
  </Data>
  <Success>true</Success>
</QueryDeviceGroupInfoResponse>

JSON格式

{
    "RequestId": "7411716B-A488-4EEB-9AA0-6DB05AD2491F",
    "Data": {
        "GroupName": "aliyun",
        "UtcCreate": "2021-10-14T14:35:51.000Z",
        "DeviceOnline": 0,
        "GroupDesc": "usefulGroup",
        "DeviceActive": 1,
        "DynamicGroupExpression": "product_key = \"a1***\" and name LIKE \"test%\"",
        "DeviceCount": 10,
        "GroupId": "tDQvBJqbUyHs****"
    },
    "Success": true
}

錯誤碼

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