You can call this operation to query the details of a domain name task 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 QueryTaskDetailList

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

PageNum Integer Yes 1

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

The number of entries to return on each page.
TaskNo String Yes 75addb07-28a3-450e-b5ec-test

The ID of the task that you want to query.
TaskStatus Integer No 2

The status of the task. Valid values:

  • 0: To be executed
  • 1: Being executed
  • 2: Succeeded
  • 3: Failed
Lang String No en

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

  • zh: Chinese
  • en: English

Default value: en
DomainName String No test.com

The domain name.
InstanceId String No S20179H1BBI9test

The instance ID of the domain name.
UserClientIp String No 127.0.0.0

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

Response parameters

Parameter Type Example Description
RequestId String 6A2320E4-D870-49C9-A6DC-test

The ID of the request.
TotalItemNum Integer 1

The number of items returned.
CurrentPageNum Integer 1

The page number of the returned page.
TotalPageNum Integer 1

The total number of pages returned.
PageSize Integer 2

The number of entries returned per page.
PrePage Boolean false

Indicates whether the current page follows another page.
NextPage Boolean true

Indicates whether the current page is followed by another page.
Data Array

The returned task details.
TaskNo String 60d6e201-8ee5-47ab-8fdc-test

The ID of the task that was queried.
TaskDetailNo String 75addb07-28a3-450e-b5ec-test

The ID of the task details returned.
TaskType String ORDER_RENEW

The type of the task. Valid values:

  • CHG_HOLDER: Update the holder information
  • CHG_DNS: Change DNS servers
  • SET_WHOIS_PROTECT: Set privacy protection
  • UPDATE_ADMIN_CONTACT: Update the administrator information
  • UPDATE_BILLING_CONTACT: Update the payer information
  • UPDATE_TECH_CONTACT: Update the technical support information
  • SET_UPDATE_PROHIBITED: Set security locks for the domain name
  • SET_TRANSFER_PROHIBITED: Set the transfer prohibition 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
InstanceId String S20179H1BBI9test

The instance ID of the domain name.
DomainName String test.com

The domain name.
TaskStatus String EXECUTE_SUCCESS

The status of the task. Valid values:

  • WAITING_EXECUTE: To be executed
  • EXECUTING: Being executed
  • EXECUTE_SUCCESS: Succeeded
  • EXECUTE_FAILURE: Failed
UpdateTime String 2018-01-25 20:47:01

The last time when the task was executed for the.
CreateTime String 2018-01-25 20:46:57

The time when the task was created.
TryCount Integer 0

The number of query retries.
ErrorMsg String The operation is successful.

The message indicating the result of the task.
TaskStatusCode Integer 2

The status code of the task. Valid values:

  • 0: To be executed
  • 1: Being executed
  • 2: Succeeded
  • 3: Failed
TaskResult String 12345

The task execution result, which can be the execution result of some types of tasks.
TaskTypeDescription String Create a renewal order

The description of the task type.

Examples

Sample requests

http(s)://[Endpoint]/? Action=QueryTaskDetailList
&PageNum=1
&PageSize=1
&TaskNo=75addb07-28a3-450e-b5ec-test
&<Common request parameters>

Sample success responses

XML format 

<QueryTaskDetailListResponse>
  <currentPageNum>1</currentPageNum>
  <data>
        <createTime>2018-01-25 20:46:57</createTime>
        <domainName>test.com</domainName>
        <errorMsg>The operation is successful.</errorMsg>
        <instanceId>S20179H1BBI9test</instanceId>
        <taskDetailNo>d2402d834c9e4db880d375173e786738</taskDetailNo>
        <taskNo>75addb07-28a3-450e-b5ec-test</taskNo>
        <taskStatus>EXECUTE_SUCCESS</taskStatus>
        <taskStatusCode>2</taskStatusCode>
        <taskType>ORDER_RENEW</taskType>
        <tryCount>0</tryCount>
        <updateTime>2018-01-25 20:47:01</updateTime>
  </data>
  <pageSize>2</pageSize>
  <requestId>6A2320E4-D870-49C9-A6DC-test</requestId>
  <totalItemNum>1</totalItemNum>
  <totalPageNum>1</totalPageNum>
</QueryTaskDetailListResponse>

JSON format 

{
  "currentPageNum": 1,
  "data": [
    {
      "createTime": "2018-01-25 20:46:57",
      "domainName": "test.com",
      "errorMsg": "The operation is successful.",
      "instanceId": "S20179H1BBI9test",
      "taskDetailNo": "d2402d834c9e4db880d375173e786738",
      "taskNo": "75addb07-28a3-450e-b5ec-test",
      "taskStatus": "EXECUTE_SUCCESS",
      "taskStatusCode": 2,
      "taskType": "ORDER_RENEW",
      "tryCount": 0,
      "updateTime": "2018-01-25 20:47:01"
    }
  ],
  "pageSize": 2,
  "requestId": "6A2320E4-D870-49C9-A6DC-test",
  "totalItemNum": 1,
  "totalPageNum": 1
}

Error codes

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