Queries the details of a specific 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. Maximum value: 1000.

TaskNo String Yes 75addb07-28a3-450e-b5ec-test

The ID of the task.

TaskStatus Integer No 2

The status of the task. Valid values:

  • 0: The task is waiting to be run.
  • 1: The task is being run.
  • 2: The task is run.
  • 3: The task fails to be run.
InstanceId String No S20179H1BBI9test

The instance ID of the domain name.

DomainName String No example.com

The domain name.

Lang String No en

The language in which the system returns the error message. Valid values:

  • zh: Chinese
  • en: English

Default value: en.

UserClientIp String No 127.0.0.0

The IP address of the client that is used for the query. Set the value to 127.0.0.1.

Response parameters

Parameter Type Example Description
CurrentPageNum Integer 1

The page number of the returned page.

Data Array of TaskDetail

The tasks.

TaskDetail
CreateTime String 2018-01-25 20:46:57

The time when the task was created.

DomainName String example.com

The domain name.

ErrorMsg String The operation is successful.

The message that indicates the running result of the task.

InstanceId String S20179H1BBI9test

The instance ID of the domain name.

TaskDetailNo String 75addb07-28a3-450e-b5ec-test

The ID of the task details returned.

TaskNo String 60d6e201-8ee5-47ab-8fdc-test

The ID of the task.

TaskResult String 12345

The running result of the task.

TaskStatus String EXECUTE_SUCCESS

The status of the task. Valid values:

  • WAITING_EXECUTE: The task is waiting to be run.
  • EXECUTING: The task is being run.
  • EXECUTE_SUCCESS: The task is run.
  • EXECUTE_FAILURE: The task fails to be run.
TaskStatusCode Integer 2

The status code of the task. Valid values:

  • 0: The task is waiting to be run.
  • 1: The task is being run.
  • 2: The task is run.
  • 3: The task fails to be run.
TaskType String ORDER_RENEW

The type of the task. Valid values:

  • CHG_HOLDER: The task is run to modify the domain name registrant.
  • CHG_DNS: The task is run to change the DNS servers of the domain name.
  • SET_WHOIS_PROTECT: The task is run to configure privacy protection for the domain name.
  • UPDATE_ADMIN_CONTACT: The task is run to modify the information of the administrator of the domain name.
  • UPDATE_BILLING_CONTACT: The task is run to modify the information of the payer for the domain name.
  • UPDATE_TECH_CONTACT: The task is run to modify the information of the technical support for the domain name.
  • SET_UPDATE_PROHIBITED: The task is run to configure the security lock for the domain name.
  • SET_TRANSFER_PROHIBITED: The task is run to configure the transfer lock for the domain name.
  • ORDER_ACTIVATE: The task is run to create a registration order for the domain name.
  • ORDER_RENEW: The task is run to create a renewal order for the domain name.
  • ORDER_REDEEM: The task is run to create a redemption order for the domain name.
  • CREATE_DNSHOST: The task is run to create a DNS server for the domain name.
  • UPDATE_DNSHOST: The task is run to update the information about a DNS server for the domain name.
  • SYNC_DNSHOST: The task is run to synchronize a DNS server for the domain name.
TaskTypeDescription String Creation of a renewal order

The description of the task type.

TryCount Integer 0

The number of the query retries.

UpdateTime String 2018-01-25 20:47:01

The last time when the task was run.

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 6A2320E4-D870-49C9-A6DC-test

The ID of the request.

TotalItemNum Integer 1

The total number of entries returned.

TotalPageNum Integer 1

The total number of pages returned.

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.