All Products
Search

This Product

    Edge Security Acceleration:DescribeDcdnRefreshTaskById

    Document Center

    Edge Security Acceleration:DescribeDcdnRefreshTaskById

    Last Updated:Mar 28, 2026

    Queries the status of a refresh or prefetch task by its ID.

    Operation description

    Note

    • You can query data generated within the last three days.

    • Each account can call this operation up to 30 times per second.

    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

    dcdn:DescribeDcdnRefreshTaskById

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    TaskId

    string

    Yes

    The ID of the task to query. You can obtain task IDs by calling the following operations:

    Note

    You can specify up to 10 task IDs in each request. Separate multiple task IDs with commas (,).

    113681**

    Response elements

    Element

    Type

    Description

    Example

    object

    TotalCount

    integer

    The total number of tasks.

    2
    RequestId

    string

    The request ID.

    E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B
    Tasks

    array<object>

    The list of refresh or prefetch tasks.

    object

    Status

    string

    The status of the task. Valid values:

    • Complete: The task is complete.

    • Pending: The task is waiting to be processed.

    • Refreshing: The task is in progress.

    • Failed: The task failed.

    Complete
    CreationTime

    string

    The time when the task was created. The time is in Coordinated Universal Time (UTC) and formatted as yyyy-MM-ddTHH:mm:ssZ.

    2021-05-10T08:54:23Z
    ObjectType

    string

    The type of the refresh or prefetch task. Valid values:

    • file: File refresh.

    • directory: Directory refresh.

    • preload: File prefetch.

    file
    Process

    string

    The progress of the task in percentage.

    100%
    Description

    string

    The description of the error if the task failed. Valid values:

    • Internal Error: An internal error occurred.

    • Origin Timeout: The origin server timed out.

    • Origin Return StatusCode 5XX: The origin server returned a 5xx error code.

    Internal Error
    ObjectPath

    string

    The path of the object that is refreshed or prefetched.

    http://example.com/image_01.png
    TaskId

    string

    The ID of the task.

    113681**

    Examples

    Success response

    JSON format

    {
  "TotalCount": 2,
  "RequestId": "E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B",
  "Tasks": [
    {
      "Status": "Complete",
      "CreationTime": "2021-05-10T08:54:23Z",
      "ObjectType": "file",
      "Process": "100%",
      "Description": "Internal Error",
      "ObjectPath": "http://example.com/image_01.png",
      "TaskId": "113681**"
    }
  ]
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameters The specified parameters are invalid. A parameter is set to an invalid value.
    400 InvalidTaskId.Malformed The specified TaskId is invalid. The value specified for the TaskId parameter is invalid.
    400 InvalidTaskId The maximum number of taskIds is 10. The number of task IDs (taskIds) cannot exceed 10.
    400 InvalidTime The query time cannot exceed the last 3 days. You can query data up to the last three days.
    429 TooManyRequests The server is busy. Please try again later. The server is unavailable. Try again later.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.