Calls the DescribeDomains operation to query domain names of a user based on input parameters.

  • You can specify the PageNumber and PageSize parameters to query domain names.
  • You can specify the KeyWord parameter to query domain names that contain the specified keyword.
  • By default, the domain names in a list are sorted in descending order of the time they were added.
  • You can specify the GroupId parameter. If you do not specify this parameter, all domain names are queried by default.

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 DescribeDomains

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

GroupId String No 2223

The ID of the domain name group. If you do not specify this parameter, all domain names are queried by default.

KeyWord String No com

The keyword 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.

ResourceGroupId String No rg-resourcegroupid01

The ID of the resource group.

SearchMode String No LIKE

The search mode. Valid values:

  • LIKE: fuzzy match.
  • EXACT: exact match.
Starmark Boolean No true

Specifies whether to query the starmark of the domain name.

Response parameters

Parameter Type Example Description
Domains Array

The list of domain names queried by this operation.

Domain

Details about a domain name queried by this operation.

AliDomain Boolean true

Indicates whether the domain name is an Alibaba Cloud HiChina domain name.

DnsServers List {"DnsServer": ["ns1.alidns.com","ns2.alidns.com"]}

The list of DNS servers of the domain name in the DNS system.

DnsServer

Details about a DNS server of the domain name in the DNS system.

DomainId String 00efd71a-770e-4255-b54e-6fe5659baffe

The ID of the domain name.

DomainName String abc.com

The domain name.

GroupId String 2223

The ID of the domain name group.

GroupName String mygroup

The name of the domain name group.

InstanceEndTime String 2020-03-14T16:00Z

The expiration time of the instance.

InstanceExpired Boolean false

Indicates whether the instance expired.

InstanceId String i-7bg

The ID of the Alibaba Cloud DNS instance.

PunyCode String abc.com

The punycode is returned for Chinese domain names and is left blank for English domain names.

RecordCount Long 100

The number of DNS records of the domain name.

RegistrantEmail String test@example.com

The email address of the registrant.

Remark String remark

The description.

Starmark Boolean true

Indicates whether to query the starmark of the domain name.

VersionCode String version_enterprise_basic

The version code of the Alibaba Cloud DNS instance.

VersionName String Enterprise Standard Edition

The version name of the Alibaba Cloud DNS instance.

PageNumber Long 1

The page number of the returned page.

PageSize Long 2

The number of entries returned per page.

RequestId String 68386699-8B9E-4D5B-BC4C-75A28F6C2A00

The ID of the request.

TotalCount Long 2

The total number of domain names.

Examples

Sample requests


http(s)://[Endpoint]/?Action=DescribeDomains
&<Common request parameters>

Sample success responses

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>example.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 format

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

Error codes

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