Queries the details of a group.

Limits

Each Alibaba Cloud account can run a maximum of 30 queries per second (QPS).

Note RAM users of an Alibaba Cloud account share the quota of the account.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes QueryDeviceGroupInfo

The operation that you want to perform. Set the value to QueryDeviceGroupInfo.

GroupId String Yes tDQvBJqbUyHs****

The ID of the group. The ID is the globally unique identifier (GUID) for the group.

You can call the QueryDeviceGroupList operation to query the GroupId parameter.

IotInstanceId String No iot-cn-0pp1n8t****

The ID of the instance. You can view the instance ID on the Overview page in the IoT Platform console.

Notice
  • If your instance has an ID, you must configure this parameter. If you do not set this parameter, the call fails.
  • If your instance has no Overview page or ID, you do not need to set this parameter.

For more information, see Overview.

GroupType String No LINK_PLATFORM_DYNAMIC

The type of the group.

Set the value to LINK_PLATFORM_DYNAMIC. This value indicates a dynamic group. If you do not specify this parameter, a static group is queried by default.

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information, see Common request parameters.

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

The error code returned if the call fails. For more information, see Error codes.

Data Struct

The group details returned if the call succeeds. This parameter includes the following parameters.

DeviceActive Integer 1

The number of activated devices.

DeviceCount Integer 10

The total number of devices.

DeviceOnline Integer 0

The number of online devices.

DynamicGroupExpression String product_key = "a1***" and name LIKE "test%"

The rule of the dynamic group. This parameter is returned if a dynamic group is queried.

GroupDesc String usefulGroup

The description of the group.

GroupId String tDQvBJqbUyHs****

The ID of the group.

GroupName String aliyun

The name of the group.

UtcCreate String 2018-09-14T14:35:51.000Z

The time when the group was created.

ErrorMessage String A system exception occurred.

The error message returned if the call fails.

RequestId String 7411716B-A488-4EEB-9AA0-6DB05AD2491F

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

  • true: The call was successful.
  • false: The call failed.

Examples

Sample requests

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceGroupInfo
&GroupId=tDQvBJqbUyHs****
&<Common request parameters>

Sample success responses

XML format

<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 format

{
    "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
}

Error codes

For a list of error codes, visit the API Error Center.