edit-icon download-icon

Retrieving Domain Name Group Lists

Last Updated: May 27, 2016

Description

Retrieves all group lists based on input parameters.

Request Parameters

Name Type Required? Description
Action String Yes Operator interface name, required parameter, value:DescribeDomainGroups
PageNumber Long No Number of the current page, starting from 1 by default
PageSize Long No This sets the number of lines per page for query by pages, up to 100 and 20 by default
KeyWord String No The group name keyword for searches using the ”%KeyWord%” mode, case insensitive

Return Parameters

Public return parameters. For details, see Public Return Parameters.

Name Type Description
RequestId String The unique request identifier
TotalCount Long Number of domain name groups
PageNumber Long Number of the current page
PageSize Long The number of domain name groups obtained from the current query
DomainGroups DomainGroupType The hierarchical domain name group list

Error Codes

For errors common to all interfaces, please refer to the Error Code Table.

Example

Request Example

http://dns.aliyuncs.com/?Action=DescribeDomainGroups
&PageNumber=1
&PangeSize=20
&KeyWord=Group
&<Public Request Parameters>

Return Example

XML Format

<DescribeDomainGroupsResponse>
    <RequestId>536E9CAD-DB30-4647-AC87-AA5CC38C5382</RequestId>
    <TotalCount>1</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>2</PageSize>
    <DomainGroups>
        <DomainGroup>
            <GroupId>2223</GroupId>
            <GroupName>MyGroup</GroupName>
        </DomainGroup>
    </DomainGroups>
</DescribeDomainGroupsResponse>

JSON Example

{
    "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 2,
    "DomainGroups": {
        "DomainGroup": [
            {
                "GroupId": "2223",
                "GroupName": "MyGroup"
            }
        ]
    }
}
Thank you! We've received your feedback.