All Products
Search
Document Center

:QueryTaskDetailList

Last Updated:Mar 19, 2025

Queries the details of a specific domain name task by page.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
domain:QueryDomainTaskget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TaskStatusintegerNo

The task status. Valid value:

  • 0: waiting for execution
  • 1: being executed
  • 2: successful
  • 3: failed
2
LangstringNo

The language of the error message to return if the request fails. Valid value:

  • zh: Chinese
  • en: English

Default value: en.

en
TaskNostringYes

The task ID.

75addb07-28a3-450e-b5ec-test
DomainNamestringNo

The domain name.

example.com
InstanceIdstringNo

The instance ID of the domain name.

S20179H1BBI9test
UserClientIpstringNo

The IP address of the client. Set the value to 127.0.0.1.

127.0.0.0
PageNumintegerYes

The page number.

1
PageSizeintegerYes

The number of entries to return on each page. Maximum value: 1000.

1

Response parameters

ParameterTypeDescriptionExample
object
PrePageboolean

Indicates whether the current page is preceded by a page.

false
CurrentPageNuminteger

The page number returned.

1
RequestIdstring

The request ID.

6A2320E4-D870-49C9-A6DC-test
PageSizeinteger

The number of entries per page.

2
TotalPageNuminteger

The total number of pages.

1
Dataarray<object>

The tasks.

TaskDetailobject
UpdateTimestring

The last time when the task was run.

2018-01-25 20:47:01
TaskDetailNostring

The ID of the task details.

75addb07-28a3-450e-b5ec-test
CreateTimestring

The time when the task was created.

2018-01-25 20:46:57
InstanceIdstring

The instance ID of the domain name.

S20179H1BBI9test
DomainNamestring

The domain name.

example.com
TaskTypestring

The task type. Valid values:

  • CHG_HOLDER: The task is run to modify the domain name registrant.
  • CHG_DNS: The task is run to change the Domain Name System (DNS) servers.
  • 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 about the administrator of the domain name.
  • UPDATE_BILLING_CONTACT: The task is run to modify the information about the payer for the domain name.
  • UPDATE_TECH_CONTACT: The task is run to modify the information about 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.
ORDER_RENEW
TaskNostring

The task ID.

60d6e201-8ee5-47ab-8fdc-test
TaskResultstring

The result of the task.

12345
TaskStatusCodeinteger

The status code of the task. Valid values:

  • 0: waiting for execution
  • 1: being executed
  • 2: successful
  • 3: failed
2
TaskStatusstring

The task status. Valid values:

  • WAITING_EXECUTE: To be executed
  • EXECUTING: being executed
  • EXECUTE_SUCCESS: successful
  • EXECUTE_FAILURE: failed
EXECUTE_SUCCESS
TaskTypeDescriptionstring

The description of the task type.

TryCountinteger

The number of times the task was retried.

0
ErrorMsgstring

The error message returned when the task failed.

The operation is successful.
FailReasonstring

The cause of a domain name task failure.

Purchase record exists for the domain name in Aliyun
TotalItemNuminteger

The total number of entries.

1
NextPageboolean

Indicates whether the current page is followed by a page.

true

Examples

Sample success responses

JSONformat

{
  "PrePage": false,
  "CurrentPageNum": 1,
  "RequestId": "6A2320E4-D870-49C9-A6DC-test",
  "PageSize": 2,
  "TotalPageNum": 1,
  "Data": {
    "TaskDetail": [
      {
        "UpdateTime": "2018-01-25 20:47:01",
        "TaskDetailNo": "75addb07-28a3-450e-b5ec-test",
        "CreateTime": "2018-01-25 20:46:57",
        "InstanceId": "S20179H1BBI9test",
        "DomainName": "example.com",
        "TaskType": "ORDER_RENEW",
        "TaskNo": "60d6e201-8ee5-47ab-8fdc-test",
        "TaskResult": "12345",
        "TaskStatusCode": 2,
        "TaskStatus": "EXECUTE_SUCCESS",
        "TaskTypeDescription": "",
        "TryCount": 0,
        "ErrorMsg": "The operation is successful.",
        "FailReason": "Purchase record exists for the domain name in Aliyun\n"
      }
    ]
  },
  "TotalItemNum": 1,
  "NextPage": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-07-22The response structure of the API has changedView Change Details