You can call this operation to query the domain name tasks 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 QueryTaskList

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

PageNum Integer Yes 1

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

The number of entries to return on each page.
BeginCreateTime Long No 1522080000000

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

EndCreateTime Long No 1522080000000

The end of the time range to query the expiration date. The time is expressed as the number of milliseconds that have 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
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 1

The page number of the returned page.
Data

The list of returned tasks.
TaskInfo

The details of a returned task.
Clientip String 127.0.0.1

The IP address of the client used by the user to initiate the query.
CreateTime String Dec 26,2017 11:00:54

The time when the task was created.
TaskCancelStatus String INIT

The cancellation status of the task. Valid values:

  • INIT: Not canceled
  • CANCELLING: Being canceled
  • COMPLETE: Canceled
TaskCancelStatusCode Integer 0

The code of the task cancellation status. Valid values:

  • 0: Not canceled
  • 1: Being canceled
  • 2: Canceled
TaskNo String 8b1cd755-4928-4b02-adee-e5d41d7b1939

The ID of the task that was queried.
TaskNum Integer 1

The number of domain names involved in the task.
TaskStatus String COMPLETE

The status of the task. Valid values:

  • WAITING_EXECUTE: To be executed
  • EXECUTING: Being executed
  • COMPLETE: Executed
TaskStatusCode Integer 1

The status code of the task. Valid values:

  • 1: To be executed
  • 2: Being executed
  • 3: Executed
TaskType String CREATE_DNSHOST

The type of the task. Valid values:

  • CHG_HOLDER: Modify the registrant information.
  • CHG_DNS: Modify DNS.
  • SET_WHOIS_PROTECT: Set privacy protection.
  • UPDATE_ADMIN_CONTACT: Modify the administrator information.
  • UPDATE_BILLING_CONTACT: Modify the payer information.
  • UPDATE_TECH_CONTACT: Modify the technician information.
  • SET_UPDATE_PROHIBITED: Set the security lock for the domain name.
  • SET_TRANSFER_PROHIBITED: Set the transfer lock for the domain name.
  • ORDER_ACTIVATE: Create a registration order.
  • ORDER_RENEW: Create a renewal order.
  • ORDER_REDEEM: Create a redemption order.
  • CREATE_DNSHOST: Create a DNS host.
  • UPDATE_DNSHOST: Update the DNS host.
  • SYNC_DNSHOST: Synchronize the DNS host.
TaskTypeDescription String Create a DNS host

The description of the task type.
NextPage Boolean true

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

The number of entries returned per page.
PrePage Boolean false

Indicates whether the current page follows another page.
RequestId String 8D7D294A-8E99-481F-B64C-017EFC793059

The ID of the request.
TotalItemNum Integer 43

The total number of returned entries.
TotalPageNum Integer 22

The total number of returned pages.

Examples

Sample requests


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

Sample success responses

XML format 

<QueryTaskListResponse>
      <Data>
            <TaskInfo>
                  <Clientip>127.0.0.1</Clientip>
                  <TaskNo>8b1cd755-4928-4b02-adee-e5d41d7b1939</TaskNo>
                  <CreateTime>Dec 26,2017 11:00:54</CreateTime>
                  <TaskStatus>COMPLETE</TaskStatus>
                  <TaskNum>1</TaskNum>
                  <TaskType>CREATE_DNSHOST</TaskType>
            </TaskInfo>
            <TaskInfo>
                  <Clientip>127.0.0.1</Clientip>
                  <TaskNo>b0069db5-db21-4e57-842a-260c370a37e2</TaskNo>
                  <CreateTime>Dec 26,2017 11:00:54</CreateTime>
                  <TaskStatus>COMPLETE</TaskStatus>
                  <TaskNum>2</TaskNum>
                  <TaskType>CHG_DNS</TaskType>
            </TaskInfo>
      </Data>
      <TotalItemNum>43</TotalItemNum>
      <PageSize>2</PageSize>
      <CurrentPageNum>1</CurrentPageNum>
      <RequestId>8D7D294A-8E99-481F-B64C-017EFC793059</RequestId>
      <TotalPageNum>22</TotalPageNum>
</QueryTaskListResponse>

JSON format 

{
	"Data":{
		"TaskInfo":[
			{
				"Clientip":"127.0.0.1",
				"TaskNo":"8b1cd755-4928-4b02-adee-e5d41d7b1939",
				"CreateTime":"Dec 26,2017 11:00:54",
				"TaskStatus":"COMPLETE",
				"TaskNum":1,
				"TaskType":"CREATE_DNSHOST"
			},
			{
				"Clientip":"127.0.0.1",
				"TaskNo":"b0069db5-db21-4e57-842a-260c370a37e2",
				"CreateTime":"Dec 26,2017 11:00:54",
				"TaskStatus":"COMPLETE",
				"TaskNum":2,
				"TaskType":"CHG_DNS"
			}
		]
	},
	"TotalItemNum":43,
	"PageSize":2,
	"CurrentPageNum":1,
	"RequestId":"85C735DC-872F-423B-A728-C20C2924D3C6",
	"TotalPageNum":22
}

Error codes

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