edit-icon download-icon

Retrieving Domain Name Lists

Last Updated: May 27, 2016

Description

Queries the domain name list of this user based on input parameters.

  • The page number (PageNumber) and the size of each page (PageSize) may be specified in the query so as to get the list of domain names.
  • A key word (KeyWord) of the domain name can be specified in the query to get the list of domain names that contain the key word.
  • By default, the domain name list is sorted by time domain names are added, from most to least recent.
  • The ID of the domain name group (GroupId) can be specified in the query. The default value is All Groups.

Request Parameters

Name Type Required? Description
Action String Yes Operation interface name, required parameter. Value: DescribeDomains
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 keyword for searches using the ”%KeyWord%” mode, case insensitive
GroupId String No The ID of the domain name group. If not filled in, it is All Groups, by default

Return Parameters

Public return parameters. For details, see Public Return Parameters

Name Type Description
RequestId String The unique request identifier
TotalCount Long Total number of domain name lists
PageNumber Long Number of the current page
PageSize Long The number of domain names retrieved by this query
Domains DomainType The list of domains retrieved by this operation

Error Codes

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

Error Code Description HTTP Status Code Language
InvalidDomainGroup.NotExist The domain group name is not exist. 400 The domain name group does not exist

Example

Request Example

http://dns.aliyuncs.com/?Action=DescribeDomains
&PageNumber=1
&PageSize=20
&KeyWord=com
&GroupId=2223
&<Public Request Parameters>

Return Example

XML Format

<DescribeDomainsResponse>
    <RequestId>6393C3A8-B611-42F2-AFA6-F080FC45D5D0</RequestId>
    <TotalCount>2</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>2</PageSize>
    <Domains>
        <Domain>
            <DomainId>00efd71a-770e-4255-b54e-6fe5659baffe</DomainId>
            <DomainName>abc.com</DomainName>
            <AliDomain>true</AliDomain>
            <GroupId>2223</GroupId>
            <PunyCode>abc.com</PunyCode>
            <InstanceId>i-7bg</InstanceId>
            <VersionCode>version1</VersionCode>
            <DnsServers>
                <DnsServer>dns1.hichina.com</DnsServer>
                <DnsServer>dns2.hichina.com</DnsServer>
            </DnsServers>
        </Domain>
        <Domain>
            <DomainId>00efd71a-770e-4255-b54e-6fe5659baffe</DomainId>
            <DomainName>Instance.com</DomainName>
            <AliDomain>false</AliDomain>
            <GroupId>2223</GroupId>
            <PunyCode>xn--fsq270a.com</PunyCode>
            <InstanceId>i-7bk</InstanceId>
            <VersionCode>version2</VersionCode>
            <DnsServers>
                <DnsServer>dns1.hichina.com</DnsServer>
                <DnsServer>dns2.hichina.com</DnsServer>
            </DnsServers>
        </Domain>
    </Domains>
</DescribeDomainsResponse>

JSON Example

{
    "RequestId": "68386699-8B9E-4D5B-BC4C-75A28F6C2A00",
    "TotalCount": 2,
    "PageNumber": 1,
    "PageSize": 2,
    "Domains": {
        "Domain": [
            {
                "DomainId": "00efd71a-770e-4255-b54e-6fe5659baffe",
                "DomainName": "abc.com",
                "AliDomain": "true",
                "GroupId": "2223",
                "PunyCode": "abc.com",
                "InstanceId": "i-7bg",
                "VersionCode": "version1",
                "DnsServers": {
                    "DnsServer": [
                        "ns1.alidns.com",
                        "ns2.alidns.com"
                    ]
                }
            },
            {
                "DomainId": "00efd71a-770e-4255-b54e-6fe5659baffe",
                "DomainName": "Instance.com",
                "AliDomain": "false",
                "GroupId": "2223",
                "PunyCode": "xn--fsq270a.com",
                "InstanceId": "i-7bk",
                "VersionCode": "version2",
                "DnsServers": {
                    "DnsServer": [
                        "ns1.alidns.com",
                        "ns2.alidns.com"
                    ]
                }
            }
        ]
    }
}
Thank you! We've received your feedback.