Calls the DescribeDomainGroups operation to query all domain name groups based on input parameters.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeDomainGroups |
The operation that you want to perform. Set the value to DescribeDomainGroups. |
KeyWord | String | No | Group |
The keyword of the domain name group for searches in %KeyWord% mode. The value is not case-sensitive. |
Lang | String | No | en |
The language type. |
PageNumber | Long | No | 1 |
The number of the page to return. Pages start from page 1. Default value: 1. |
PageSize | Long | No | 20 |
The number of entries to return on each page. Maximum value: 100. Default value: 20. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
DomainGroups | Array |
The list of domain name groups. |
|
DomainGroup |
Details about a domain name group. |
||
DomainCount | Long | 2 |
The number of domain name groups. |
GroupId | String | 2223 |
The ID of the domain name group. |
GroupName | String | MyGroup |
The name of the domain name group. |
PageNumber | Long | 1 |
The page number of the returned page. |
PageSize | Long | 2 |
The number of entries returned per page. |
RequestId | String | 536E9CAD-DB30-4647-AC87-AA5CC38C5382 |
The ID of the request. |
TotalCount | Long | 1 |
The total number of domain name groups. |
Examples
Sample requests
http(s)://alidns.aliyuncs.com/?Action=DescribeDomainGroups
&<Common request parameters>
Sample success responses
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
format
{
"PageNumber":1,
"DomainGroups":{
"DomainGroup":[
{
"GroupName":"MyGroup",
"GroupId":"2223"
}
]
},
"TotalCount":1,
"PageSize":2,
"RequestId":"536E9CAD-DB30-4647-AC87-AA5CC38C5382"
}
Error codes
For a list of error codes, visit the API Error Center.