Call DescribeRefreshTasks to query the status of refresh and prefetch tasks - CDN - Alibaba Cloud - CDN

Call DescribeRefreshTasks to check the status of refresh and prefetch tasks for the entire network.

Operation description

You can query tasks by task ID or URL.
You can specify both the TaskId and ObjectPath parameters. If neither TaskId nor ObjectPath is specified, the operation returns the first 20 tasks from the past three days by default.
You can only query data from the past three days.
Task status is updated asynchronously. You must call the API to retrieve the latest status.
If you enable automatic cache refresh for CDN in the OSS console, the DescribeRefreshTasks interface will not return these tasks.
The call frequency for a single user is limited to 5 calls per second. If you require a higher frequency, use the DescribeRefreshTaskById interface, which queries tasks by task ID only.

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

cdn:DescribeRefreshTasks

none

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	No	The ID of the task to query.	1234321
ObjectPath	string	No	The path of the object to query. This parameter requires an exact match.	http://example.com/1.txt
PageNumber	integer	No	The number of the page to return. Valid values: 1 to 100000.	1
ObjectType	string	No	The task type. Valid values: file: file refresh. directory: directory refresh. regex: regex refresh. preload: preload. block: URL blocking. unblock: URL unblocking. Note If you specify DomainName or Status, this parameter is required.	file
DomainName	string	No	The accelerated domain name. You can query only one domain name at a time. If you do not specify this parameter, the operation returns tasks for all your accelerated domain names.	example.com
Status	string	No	The task status. Valid values: Complete: The task finished successfully. Refreshing: The task is being processed. Timeout: The task timed out and was not executed. Canceled: The task was canceled. Failed: The task failed.	Complete
PageSize	integer	No	The number of tasks to return per page. Default value: 20. Maximum value: 100. Valid values: 1 to 100.	20
StartTime	string	No	The start of the query time range. Specify the time in ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`. The time must be in UTC.	2017-12-21T08:00:00Z
EndTime	string	No	The end of the query time range. Specify the time in ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`. The time must be in UTC. Note The end time must be later than the start time.	2017-12-22T08:00:00Z
ResourceGroupId	string	No	The resource group ID.	rg-acfmyuji4b6r4**

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	174F6032-AA26-470D-B90E-36F0EB205BEE
PageNumber	integer	The page number.	10
PageSize	integer	The page size.	1
TotalCount	integer	The total count.	2
Tasks	object
CDNTask	array<object>	The task list.
	object
Status	string	The status of the task. Valid values: Complete: The task is complete. Refreshing: The task is in progress. Failed: The task failed.	Complete
CreationTime	string	The time when the task was created. The time is in UTC.	2014-11-27T08:23:22Z
ObjectType	string	The type of the task. Valid values: file: URL directory: directory regex: regular expression preload: prefetch	file
Process	string	The progress of the task in percentage.	100%
Description	string	The error message returned if a refresh or prefetch task fails. InternalError: An internal error occurred. OriginTimeout: The origin server timed out. OriginReturnStatusCode 5XX: The origin server returned an HTTP 5xx status code.	Internal Error
ObjectPath	string	The path of the object that is refreshed.	http://example.com/1.txt
TaskId	string	The ID of the task.	704225667

Examples

Success response

JSON format

{
  "RequestId": "174F6032-AA26-470D-B90E-36F0EB205BEE",
  "PageNumber": 10,
  "PageSize": 1,
  "TotalCount": 2,
  "Tasks": {
    "CDNTask": [
      {
        "Status": "Complete",
        "CreationTime": "2014-11-27T08:23:22Z",
        "ObjectType": "file",
        "Process": "100%",
        "Description": "Internal Error",
        "ObjectPath": "http://example.com/1.txt",
        "TaskId": "704225667"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidTaskId.Malformed	The specified TaskId is invalid.
400	MissingParameter.ObjectType	The ObjectType parameter is required if DomainName or Status is specified.
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	You must set both the start time and the end time.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	EndTime is earlier than StartTime.
400	DomainNameOverLimit	A maximum of 500 domains are supported for each request.
400	InvalidTime	The query time cannot exceed the last 3 days.
400	InvalidStartTime.Malformed	The specified StartTime is invalid.	The format of the start time is invalid. Specify a valid value.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.	The EndTime parameter is set in an invalid format. For more information, see the API references.
400	InvalidObjectPath.Malformed	The specified ObjectPath is invalid.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The specified start time is invalid. For more information, see the API references.
400	InvalidEndTime.ValueNotSupported	The specified EndTime is invalid.
400	InvalidObjectType.ValueNotSupported	The specified ObjectType is not supported.
400	InvalidStatus.ValueNotSupported	The specified Status is not supported.
400	InvalidParams	The parameter you provided is invalid.	The parameter entered is illegal.
429	TooManyRequests	The server is busy. Please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.