Queries groups by page.


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

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


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 QueryDeviceGroupList

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

IotInstanceId String No iot_instc_pu****_c*-v64********

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

  • 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.

PageSize Integer No 10

The number of the entries to return on each page. Maximum value: 200. Default value: 10.

SuperGroupId String No 8vDubXr4nUvZkNgk9mle010200

The ID of the parent group. If you need to query the subgroups of a parent group, specify this parameter.

GroupName String No GroupName1

The name of the group.

  • If you specify this parameter, the system queries groups by group name. You can perform a fuzzy search by group name.
  • If you do not specify this parameter, the system queries all groups.
CurrentPage Integer No 1

The number of the page to return. Default value: 1.


The type of the group to be queried.

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.

CurrentPage Integer 1

The page number of the returned page.

Data Array of GroupInfo

The group information returned if the call succeeds. For more information, see the GroupInfo parameter.

Note The returned group information is sorted in reverse chronological order in which the groups are created.
GroupDesc String usefulGroup

The description of the group.

GroupId String Kzt9FD8wje8o****

The ID of the group.

GroupName String test1

The name of the group.


The type of the group.

UtcCreate String 2018-10-09T02:58:34.000Z

The time when the group was created.

ErrorMessage String A system exception occurred.

The error message returned if the call fails.

PageCount Integer 3

The total number of pages.

PageSize Integer 10

The number of entries return on each page.

RequestId String BEFCA316-D6C7-470C-81ED-1FF4FFD4AA0D

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

  • true: The call was successful.
  • false: The call failed.
Total Integer 24

The total number of records that were returned.


Sample requests

&<Common request parameters>

Sample success responses

XML format


JSON format

                "GroupType": "LINK_PLATFORM_DYNAMIC"
                "GroupType": "LINK_PLATFORM_DYNAMIC"
                "GroupType": "LINK_PLATFORM_DYNAMIC"
                "GroupType": "LINK_PLATFORM_DYNAMIC"
                "GroupType": "LINK_PLATFORM_DYNAMIC"
                "GroupType": "LINK_PLATFORM_DYNAMIC"
                "GroupType": "LINK_PLATFORM_DYNAMIC"
                "GroupType": "LINK_PLATFORM_DYNAMIC"
                "GroupType": "LINK_PLATFORM_DYNAMIC"

Error codes

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