All Products
Search

This Product

    Edge Security Acceleration:DescribePurgeTasks

    Document Center

    Edge Security Acceleration:DescribePurgeTasks

    Last Updated:Jul 02, 2026

    Queries the execution status of refresh tasks.

    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

    esa:DescribePurgeTasks

    get

    *Site

    acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    SiteId

    integer

    No

    The site ID, which can be obtained by calling the ListSites operation.

    Important You must always specify SiteId. An error is reported if SiteId is not specified.

    123456789****
    Content

    string

    No

    The query content. Exact match is used.

    http://a.com/1.jpg?b=1
    Type

    string

    No

    The task type. Valid values:

    • file (default): file refresh.

    • cachetag: cache tag refresh.

    • directory: directory refresh.

    • ignoreParams: ignore parameters refresh.

    • hostname: hostname refresh.

    • purgeall: purge all cache under the site.

    Valid values:

    • cachetag :

      cachetag refresh.

    • hostname :

      hostname refresh.

    • file :

      file refresh.

    • cachekey :

      cachekey refresh.

    • purgeall :

      purge all.

    • ignoreparams :

      ignore parameters refresh.

    • directory :

      directory refresh.

    file
    PageNumber

    integer

    No

    The page number to return. Valid values: 1 to 100000.

    1
    PageSize

    integer

    No

    The number of entries per page. Default value: 20. Maximum value: 50. Valid values: any integer from 1 to 50.

    20
    StartTime

    string

    No

    The start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.

    2022-11-16T05:33:00Z
    EndTime

    string

    No

    The end time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.

    Note

    The end time must be later than the start time.

    2022-11-18T15:59:59Z
    Status

    string

    No

    The task execution status. Valid values:

    • Complete: Completed.

    • Refreshing: Refreshing.

    • Failed: Refresh failed.

    Valid values:

    • Refreshing :

      Refreshing.

    • Complete :

      Completed.

    • Failed :

      Refresh failed.

    Complete

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    15C66C7B-671A-4297-9187-2C4477247A123425345
    PageNumber

    integer

    The page number.

    1
    PageSize

    integer

    The number of entries per page.

    20
    TotalCount

    integer

    The total number of entries.

    15
    Tasks

    array<object>

    The task list.

    object

    Status

    string

    The status. Valid values:

    • Complete: Completed.

    • Refreshing: Refreshing.

    • Failed: Refresh failed.

    Complete
    CreateTime

    string

    The creation time in ISO 8601 format (for example, 2024-01-01T00:00:00+Z).

    2023-07-26T01:56:15Z
    Type

    string

    The refresh task type. Valid values:

    • file (default): file refresh.

    • cachetag: cache tag refresh.

    • directory: directory refresh.

    • ignoreParams: ignore parameters refresh.

    • hostname: hostname refresh.

    • purgeall: purge all cache under the site.

    file
    Process

    string

    The task completion progress in percentage.

    100%
    Description

    string

    The error description returned when the refresh task fails.

    Internal Error
    Content

    string

    The refresh object.

    http://a.com/1.jpg?b=1
    TaskId

    string

    The task ID.

    16346513304

    Examples

    Success response

    JSON format

    {
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A123425345",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 15,
  "Tasks": [
    {
      "Status": "Complete",
      "CreateTime": "2023-07-26T01:56:15Z",
      "Type": "file",
      "Process": "100%",
      "Description": "Internal Error",
      "Content": "http://a.com/1.jpg?b=1",
      "TaskId": "16346513304"
    }
  ]
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 MissingTimeParameter The StartTime and EndTime must be both specified. Please provide both a start time and an end time.
    400 InvalidEndTime.Mismatch The specified EndTime is earlier than the StartTime. The end time you entered is earlier than the start time. Please check and try again.
    400 DomainNameOverLimit A maximum of 500 domains are supported for each request. Only 500 domain names are supported at a time. Please reduce the number of domain names to request again.
    400 InvalidTime The query time cannot exceed the last 3 days. The query time cannot exceed the last 3 days.
    400 MissingParameter.ObjectType The ObjectType parameter is required if DomainName or ObjectType is specified. Specify the ObjectType parameter.
    400 InvalidStationParameter The specified Station is invalid. The specified node parameter is invalid.
    400 TooManyRequests Too many requests.Please try again later. Requests are too frequent, please try again later.
    400 InvalidTaskId.Malformed The specified taskId is invalid. The specified task ID is invalid.
    400 InvalidParameters.InvalidUrls The specified urls are invalid. The requested URL parameter is invalid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.