Queries groups by page.

Limits

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

Note Resource Access Management (RAM) users of an Alibaba Cloud account share the quota of the account.

Debugging

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 instance ID. This parameter is not required for public instances. However, this parameter is required for Enterprise Edition instances.

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.

PageSize Integer No 10

The number of entries to return on each page. Valid values: 1 to 200. Default value: 10.

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this API 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 list information returned if the call succeeds. For more information, see the GroupInfo parameter.

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

The description of each group.

GroupId String Kzt9FD8wje8o****

The ID of the group.

GroupName String test1

The name of the group.

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

The time when the group was created.

ErrorMessage String A system exception has occurred.

The error message returned if the call fails.

PageCount Integer 3

The total number of pages returned.

PageSize Integer 10

The number of entries returned per page.

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

The ID of the request.

Success Boolean true

Indicates whether the call succeeds.

  • true: The call succeeded.
  • false: The call failed.
Total Integer 24

The total number of entries returned.

Examples

Sample requests

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceGroupList
&PageSize=10
&CurrentPage=1
&<Common request parameters>

Sample success responses

XML format

<QueryDeviceGroupListResponse>
      <PageCount>3</PageCount>
      <Data>
            <GroupInfo>
                  <GroupName>test1</GroupName>
                  <UtcCreate>2018-10-09T02:58:34.000Z</UtcCreate>
                  <GroupId>Kzt9FD8wje8o****</GroupId>
            </GroupInfo>
            <GroupInfo>
                  <GroupName>test2</GroupName>
                  <UtcCreate>2018-10-09T02:56:40.000Z</UtcCreate>
                  <GroupId>0ayrSQ3DSd7u****</GroupId>
            </GroupInfo>
            <GroupInfo>
                  <GroupDesc>Test</GroupDesc>
                  <GroupName>test3</GroupName>
                  <UtcCreate>2018-09-16T05:38:27.000Z</UtcCreate>
                  <GroupId>oWXlIQeFZtzC****</GroupId>
            </GroupInfo>
            <GroupInfo>
                  <GroupName>ylv0915</GroupName>
                  <UtcCreate>2018-09-15T04:51:56.000Z</UtcCreate>
                  <GroupId>SfEiVapLPUjBVvSq</GroupId>
            </GroupInfo>
            <GroupInfo>
                  <GroupName>ydlv</GroupName>
                  <UtcCreate>2018-09-14T14:35:51.000Z</UtcCreate>
                  <GroupId>z2S2h9NsDTZm****</GroupId>
            </GroupInfo>
            <GroupInfo>
                  <GroupName>ldh_group_3</GroupName>
                  <UtcCreate>2018-09-14T12:26:20.000Z</UtcCreate>
                  <GroupId>chn5fkjinXGc****</GroupId>
            </GroupInfo>
            <GroupInfo>
                  <GroupDesc>ddd</GroupDesc>
                  <GroupName>ylvgisbim</GroupName>
                  <UtcCreate>2018-09-14T11:41:20.000Z</UtcCreate>
                  <GroupId>ncUZ8DjWYaB9****</GroupId>
            </GroupInfo>
            <GroupInfo>
                  <GroupName>abc</GroupName>
                  <UtcCreate>2018-09-14T09:14:30.000Z</UtcCreate>
                  <GroupId>zpdvwxzBdt4F****</GroupId>
            </GroupInfo>
            <GroupInfo>
                  <GroupName>test11</GroupName>
                  <UtcCreate>2018-09-14T07:22:39.000Z</UtcCreate>
                  <GroupId>BTaudF16X2xK****</GroupId>
            </GroupInfo>
            <GroupInfo>
                  <GroupName>testy</GroupName>
                  <UtcCreate>2018-09-14T01:58:06.000Z</UtcCreate>
                  <GroupId>PrTm3VOeggPw****</GroupId>
            </GroupInfo>
      </Data>
      <PageSize>10</PageSize>
      <RequestId>BEFCA316-D6C7-470C-81ED-1FF4FFD4AA0D</RequestId>
      <CurrentPage>1</CurrentPage>
      <Success>true</Success>
      <Total>24</Total>
</QueryDeviceGroupListResponse>

JSON format

{
    "PageCount":3,
    "Data":{
        "GroupInfo":[
            {
                "GroupName":"test1",
                "UtcCreate":"2018-10-09T02:58:34.000Z",
                "GroupId":"Kzt9FD8wje8o****"
            },
            {
                "GroupName":"test2",
                "UtcCreate":"2018-10-09T02:56:40.000Z",
                "GroupId":"0ayrSQ3DSd7uXXXC"
            },
            {
                "GroupDesc":"Test",
                "GroupName":"test3",
                "UtcCreate":"2018-09-16T05:38:27.000Z",
                "GroupId":"oWXlIQeFZtzC****"
            },
            {
                "GroupName":"ylv0915",
                "UtcCreate":"2018-09-15T04:51:56.000Z",
                "GroupId":"SfEiVapLPUjB****"
            },
            {
                "GroupName":"ydlv",
                "UtcCreate":"2018-09-14T14:35:51.000Z",
                "GroupId":"z2S2h9NsDTZm****"
            },
            {
                "GroupName":"ldh_group_3",
                "UtcCreate":"2018-09-14T12:26:20.000Z",
                "GroupId":"chn5fkjinXGc7pGl"
            },
            {
                "GroupDesc":"ddd",
                "GroupName":"ylvgisbim",
                "UtcCreate":"2018-09-14T11:41:20.000Z",
                "GroupId":"ncUZ8DjWYaB9****"
            },
            {
                "GroupName":"abc",
                "UtcCreate":"2018-09-14T09:14:30.000Z",
                "GroupId":"zpdvwxzBdt4F****"
            },
            {
                "GroupName":"test11",
                "UtcCreate":"2018-09-14T07:22:39.000Z",
                "GroupId":"BTaudF16X2xK****"
            },
            {
                "GroupName":"testy",
                "UtcCreate":"2018-09-14T01:58:06.000Z",
                "GroupId":"PrTm3VOeggPw****"
            }
        ]
    },
    "PageSize":10,
    "RequestId":"BEFCA316-D6C7-470C-81ED-1FF4FFD4AA0D",
    "CurrentPage":1,
    "Success":true,
    "Total":24
}

Error codes

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