You can call this operation to query the domain names under your account by page.

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 QueryDomainList

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

PageNum Integer Yes 1

The number of the page to return.
PageSize Integer Yes 10

The number of entries to return on each page.
DomainGroupId String No 123456

The ID of the domain name group.
DomainName String No test.com

The domain name that you want to query.
EndExpirationDate Long No 1522080000000

The end of the time range to query the expiration date. The time is expressed as the number of milliseconds elapsed since the epoch. The time is displayed in UTC. Currently, only querying by day is supported.

EndRegistrationDate Long No 1522080000000

The end of the time range to query the registration date. The time is expressed as the number of milliseconds elapsed since the epoch. The time is displayed in UTC. Currently, only querying by day is supported.

Lang String No en

The language of the error message to return. Valid values:

  • zh: Chinese
  • en: English

Default value:en
OrderByType String No ASC

The sorting order of the domain names. Valid values:

  • ASC: Ascending order
  • DESC: Descending order
Note Default value:DESC
OrderKeyType String No RegistrationDate

Specifies the sorting rule. Valid values:

  • RegistrationDate: Sorting by registration time.
  • ExpirationDate: Sorting by expiration time.
Note Default value: Sorting by record creation time.
ProductDomainType String No New gTLD

The type of the domain name. Valid values:

  • New gTLD
  • gTLD
  • ccTLD
QueryType String No 1

The type of domain names to be queried. Valid values:

  • 1: To be renewed urgently
  • 2: To be redeemed urgently
StartExpirationDate Long No 1522080000000

The beginning of the time range to query the expiration date. The time is expressed as the number of milliseconds elapsed since the epoch. The time is displayed in UTC. Currently, only querying by day is supported.

StartRegistrationDate Long No 1522080000000

The beginning of the time range to query the registration date. The time is expressed as the number of milliseconds elapsed since the epoch. The time is displayed in UTC. Currently, only querying by day is supported.

UserClientIp String No 127.0.0.1

The IP address of the client used by the user to initiate the query.

Response parameters

Parameter Type Example Description
CurrentPageNum Integer 0

The page number of the returned page.
Data

The list of returned domain names.
Domain

The details of a returned domain name.
DomainAuditStatus String FAILED

The status of the real-name verification for the domain name. Valid values:

  • FAILED: Failed
  • SUCCEED: Succeeded
  • NONAUDIT: Not verified
  • AUDITING: Being reviewed
DomainGroupId String 123456

The ID of the domain name group.
DomainGroupName String Test group

The name of the domain name group.
DomainName String test.com

The domain name that was queried.
DomainStatus String 3

The status of the domain name. Valid values:

  • 1: To be renewed urgently
  • 2: To be redeemed urgently
  • 3: Normal
DomainType String gTLD

The type of the domain name. Valid values:

  • New gTLD
  • gTLD
  • ccTLD
ExpirationCurrDateDiff Integer -30

The number of days between the expiration date of the domain name and the current date.

ExpirationDate String Nov 02,2019 04:00:45

The time when the domain name expired.
ExpirationDateLong Long 1522080000000

The validity period of the domain name. The time is expressed as the number of milliseconds that have elapsed since the epoch. The time is displayed in UTC.

ExpirationDateStatus String 1

The expiration status of the domain name. Valid values:

  • 1: Not expired
  • 2: Expired
InstanceId String ST20151102120031118

The instance ID of the domain name that was queried.
Premium Boolean true

Indicates whether the domain name is premium.
ProductId String 2a

The ID of the product.
RegistrantType String 1

The registration type of the domain name. Valid values:

  • 1: Individuals
  • 2: Enterprises
RegistrationDate String Nov 02,2017 04:00:45

The time when the domain name was registered.
RegistrationDateLong Long 1522080000000

Indicates how long the domain name has been registered. The time is expressed as the number of milliseconds that have elapsed since the epoch. The time is displayed in UTC.

Remark String Test notes

Remarks on the domain name that was queried.
NextPage Boolean false

Indicates whether the current page is followed by another page.
PageSize Integer 5

The number of entries returned per page.
PrePage Boolean false

Indicates whether the current page follows another page.
RequestId String B7AB5469-5E38-4AA9-A920-C65B7A9C8E6E

The ID of the request.
TotalItemNum Integer 1

The total number of domain names returned.
TotalPageNum Integer 1

The total number of returned pages.

Examples

Sample requests


http(s)://[Endpoint]/? Action=QueryDomainList
&PageNum=1
&PageSize=10
&<Common request parameters>

Sample success responses

XML format 

<? xml version='1.0' encoding='UTF-8'? >
<QueryDomainListResponse>
    <Data>
        <Domain>
            <ExpirationDate>Nov 02,2019 04:00:45</expirationDate>
            <InstanceId>ST20151102120031118</SaleId>
            <RegistrationDate>Nov 02,2017 04:00:45</registrationDate>
            <DomainName>test.com</DomainName>
            <DomainType>gTLD</domainType>
        </Domain>
    </Data>
    <TotalItemNum>1</TotalItemNum>
    <PageSize>5</PageSize>
    <CurrentPageNum>0</CurrentPageNum>
    <RequestId>B7AB5469-5E38-4AA9-A920-C65B7A9C8E6E</RequestId>
    <PrePage>false</PrePage>
    <TotalPageNum>1</TotalPageNum>
    <NextPage>false</NextPage>
</QueryDomainListResponse>

JSON format 

{
	"Data":{
		"Domain":[
			{
				"RegistrationDate":"Nov 02,2017 04:00:45",
				"InstanceId":"ST2015110212003800001928",
				"DomainType":"gTLD",
				"DomainName":"fds234sdf.net",
				"ExpirationDate":"Nov 02,2019 04:00:45"
			}
		]
	},
	"TotalItemNum":1,
	"CurrentPageNum":0,
	"PageSize":5,
	"RequestId":"77F90DA6-89AB-4074-80F3-E595CB57DF98",
	"PrePage":false,
	"TotalPageNum":1,
	"NextPage":false
}

Error codes

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