All Products
Search

This Product

    Anti-DDoS:DescribeAsyncTasks

    Document Center

    Anti-DDoS:DescribeAsyncTasks

    Last Updated:Nov 05, 2025

    Queries detailed information about asynchronous export tasks, including task ID, start and end times, status, parameters, results, and more.

    Operation description

    This operation queries detailed information about asynchronous export tasks, including task ID, start and end times, status, parameters, results, and more.

    QPS limits

    The single-user QPS limit for this operation is 10 queries per second (QPS). API calls that exceed this limit will be throttled, which may affect your business. You should call this operation at a reasonable rate.

    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

    yundun-ddoscoo:DescribeAsyncTasks

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ResourceGroupId

    string

    No

    The resource group ID of the Anti-DDoS instance in Resource Management.

    If this parameter is not specified, the default resource group is used.

    rg-acfm2pz25js****
    PageNumber

    integer

    Yes

    The page number for the paged query.

    1
    PageSize

    integer

    Yes

    The number of asynchronous export tasks to return on each page for the paged query.

    10

    When you call this API operation, in addition to the request parameters described in this topic, you must also specify the common request parameters of Alibaba Cloud API. For more information, see Common parameters.

    For the request format, see the request example in the Examples section of this topic.

    Response elements

    Parameter

    Type

    Description

    Example

    object

    TotalCount

    integer

    The total number of asynchronous export tasks that are queried.

    1
    RequestId

    string

    The ID of this request, which is generated by Alibaba Cloud as a unique identifier for this request. You can use this ID to troubleshoot and locate issues.

    6623EA1F-30FB-5BC8-BEC9-74D55F6F08F1
    AsyncTasks

    array<object>

    The detailed information about the asynchronous export tasks.

    object

    EndTime

    integer

    The end time of the task. This value is a timestamp in milliseconds.

    157927362000
    TaskType

    integer

    The type of the task. Valid values:

    • 1: Layer 4 export task, which indicates exporting port forwarding rules of the Anti-DDoS instance.

    • 2: Layer 7 export task, which indicates exporting website forwarding rules.

    • 3: Session and health check export task, which indicates exporting session and health check configuration of the Anti-DDoS instance.

    • 4: DDoS mitigation policies export task, which indicates exporting DDoS mitigation policies configuration of the Anti-DDoS instance.

    • 5: Blacklist (for destination IP addresses) download task, which indicates exporting blacklist IP addresses for the Anti-DDoS instance.

    • 6: Whitelist (for destination IP addresses) download task, which indicates exporting whitelist IP addresses for the Anti-DDoS instance.

    5
    StartTime

    integer

    The start time of the task. This value is a timestamp in milliseconds.

    156927362000
    TaskParams

    string

    The task parameters. This value is a string in the JSON format. Different TaskType values have different task parameters.

    When TaskType is 1, 3, 4, 5, or 6, the task parameters have the following structure:

    • instanceId: the ID of the Anti-DDoS instance. The type is String.

    When TaskType is 2, the task parameters have the following structure:

    • domain: the domain name of the website. The type is String.

    {"instanceId": "ddoscoo-cn-mp91j1ao****"}
    TaskStatus

    integer

    The status of the task. Valid values:

    • 0: indicates that the task is initialized.

    • 1: indicates that the task is in progress.

    • 2: indicates that the task is successful.

    • 3: indicates that the task failed.

    2
    TaskResult

    string

    The task result. This value is a string in the JSON format. Different TaskType values have different task results.

    When TaskType is 1, 3, 4, 5, or 6, the task result has the following structure:

    • instanceId: the ID of the Anti-DDoS instance. The type is String.

    • url: the OSS download URL of the exported file. The type is String.

    When TaskType is 2, the task result has the following structure:

    • domain: the domain name of the website. The type is String.

    • url: the OSS download URL of the exported file. The type is String.

    {"instanceId": "ddoscoo-cn-mp91j1ao****","url": "https://****.oss-cn-beijing.aliyuncs.com/heap.bin?Expires=1584785140&OSSAccessKeyId=TMP.3KfzD82FyRJevJdEkRX6JEFHhbvRBBb75PZJnyJmksA2QkMm47xFAFDgMhEV8Nm6Vxr8xExMfiy9LsUFAcLcTBrN3r****&Signature=Sj8BNcsxJLE8l5qm4cjNlDt8gv****"}
    TaskId

    integer

    The ID of the task.

    1

    Examples

    Success response

    JSON format

    {
  "TotalCount": 1,
  "RequestId": "6623EA1F-30FB-5BC8-BEC9-74D55F6F08F1",
  "AsyncTasks": [
    {
      "EndTime": 157927362000,
      "TaskType": 5,
      "StartTime": 156927362000,
      "TaskParams": "{\"instanceId\": \"ddoscoo-cn-mp91j1ao****\"}",
      "TaskStatus": 2,
      "TaskResult": "{\"instanceId\": \"ddoscoo-cn-mp91j1ao****\",\"url\": \"https://****.oss-cn-beijing.aliyuncs.com/heap.bin?Expires=1584785140&OSSAccessKeyId=TMP.3KfzD82FyRJevJdEkRX6JEFHhbvRBBb75PZJnyJmksA2QkMm47xFAFDgMhEV8Nm6Vxr8xExMfiy9LsUFAcLcTBrN3r****&Signature=Sj8BNcsxJLE8l5qm4cjNlDt8gv****\"}",
      "TaskId": 1
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.