All Products
Search

This Product

    :QueryTaskDetailList

    Document Center

    :QueryTaskDetailList

    Last Updated:Jul 31, 2026

    Call QueryTaskDetailList to retrieve a paginated list of task details for a specified domain name.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    domain:QueryDomainTask

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    TaskStatus

    integer

    No

    The task status. Valid values:

    • 0: Pending.

    • 1: Running.

    • 2: Succeeded.

    • 3: Failed.

    2
    Lang

    string

    No

    The language of the error message returned. Valid values:

    • zh: Chinese.

    • en: English.

    Default value: en.

    en
    TaskNo

    string

    Yes

    The task number. This is the value of the TaskNo parameter that is returned after the task is successfully run.

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

    string

    No

    The domain name.

    example.com
    InstanceId

    string

    No

    The ID of the domain name instance.

    Note

    You can call the QueryDomainByDomainName API operation to query the instance ID.

    S20179H1BBI9test
    UserClientIp

    string

    No

    The IP address of the client. You can set this parameter to 127.0.0.1.

    127.0.0.0
    PageNum

    integer

    Yes

    The page number.

    1
    PageSize

    integer

    Yes

    The number of entries per page. The maximum value is 1000.

    1

    Response elements

    Element

    Type

    Description

    Example

    object

    PrePage

    boolean

    Specifies if a previous page is available.

    false
    CurrentPageNum

    integer

    The current page number.

    1
    RequestId

    string

    The unique ID for the request.

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

    integer

    The page size.

    2
    TotalPageNum

    integer

    The total number of pages.

    1
    Data

    object

    TaskDetail

    array<object>

    The task list.

    object

    UpdateTime

    string

    The time the task was last executed.

    2018-01-25 20:47:01
    TaskDetailNo

    string

    The task detail number.

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

    string

    The task creation time.

    2018-01-25 20:46:57
    InstanceId

    string

    The ID of the domain name instance.

    S20179H1BBI9test
    DomainName

    string

    The domain name.

    example.com
    TaskType

    string

    The task type. Valid values:

    • CHG_HOLDER: Modifies owner information.

    • CHG_DNS: Changes DNS.

    • SET_WHOIS_PROTECT: Sets WHOIS protection.

    • UPDATE_ADMIN_CONTACT: Updates administrative contact information.

    • UPDATE_BILLING_CONTACT: Updates billing contact information.

    • UPDATE_TECH_CONTACT: Updates technical contact information.

    • SET_UPDATE_PROHIBITED: Sets the update lock for the domain.

    • SET_TRANSFER_PROHIBITED: Sets the domain transfer lock.

    • ORDER_ACTIVATE: Creates a registration order.

    • ORDER_RENEW: Creates a renewal order.

    • ORDER_REDEEM: Creates a redemption order.

    • CREATE_DNSHOST: Creates a DNS host.

    • UPDATE_DNSHOST: Updates a DNS host.

    • SYNC_DNSHOST: Synchronizes a DNS host.

    ORDER_RENEW
    TaskNo

    string

    The task number.

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

    string

    The task result. This parameter is returned only for certain task types.

    12345
    TaskStatusCode

    integer

    The task status code. Valid values:

    • 0: Waiting for execution

    • 1: Executing

    • 2: Execution successful

    • 3: Execution failed

    2
    TaskStatus

    string

    The task status. Valid values:

    • WAITING_EXECUTE: Waiting for execution

    • EXECUTING: Executing

    • EXECUTE_SUCCESS: Execution successful

    • EXECUTE_FAILURE: Execution failed

    EXECUTE_SUCCESS
    TaskTypeDescription

    string

    The task type description.

    创建续费订单
    TryCount

    integer

    The number of times the task was retried.

    0
    ErrorMsg

    string

    The error message for a failed task.

    The operation is successful.
    FailReason

    string

    The reason for the task failure.

    域名在万网预定业务存在购买记录
    TotalItemNum

    integer

    The total number of items.

    1
    NextPage

    boolean

    Specifies if a next page is available.

    true

    Examples

    Success response

    JSON format

    {
  "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": "域名在万网预定业务存在购买记录"
      }
    ]
  },
  "TotalItemNum": 1,
  "NextPage": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.