DescribeRefreshTaskById-阿里云帮助中心

Use DescribeRefreshTaskById to check if refresh and prefetch tasks are complete across the network.

Operation description

You can query data up to three days old.
The single-user call rate is 30 calls 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

cdn:DescribeRefreshTaskById

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	Yes	The ID of the task to query. You can obtain the `task ID` from the response of the `RefreshObjectCaches` API to query the status of a refresh or preload task. You can specify up to 10 `task ID`s, separated by commas.	12345678

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 tasks.
	object
Status	string	The status of the task. Valid values: Complete: The task is completed. Refreshing: The task is in progress. Timeout: The task timed out. Canceled: The task is canceled. Failed: The task failed.	Complete
CreationTime	string	The time when the task was created. The time is in UTC.	2020-08-03T08:54:23Z
ObjectType	string	The type of the task. Valid values: file: Refreshes a single file. directory: Refreshes a directory. preload: Preloads a single file. regex: Refreshes content based on a regular expression.	file
Process	string	The progress of the task in percentage.	100%
Description	string	The error description that is returned if the refresh or preload task fails. Valid values: Internal Error: An internal error occurs. Origin Timeout: The origin server times out. Origin Return StatusCode 5XX: The origin server returns a 5xx status code.	Internal Error
ObjectPath	string	The path of the object that is refreshed.	http://example.com/abc.jpg
TaskId	string	The task ID.	24840

Examples

Success response

JSON format

{
  "TotalCount": 2,
  "RequestId": "E0C2EF95-B1EC-4C93-855E-2059A7DA2B7B",
  "Tasks": [
    {
      "Status": "Complete",
      "CreationTime": "2020-08-03T08:54:23Z",
      "ObjectType": "file",
      "Process": "100%",
      "Description": "Internal Error",
      "ObjectPath": "http://example.com/abc.jpg",
      "TaskId": "24840"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidTaskId.Malformed	The specified TaskId is invalid.
400	InvalidObjectPath.Malformed	The specified ObjectPath is invalid.
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	You must set both the start time and the end time.
400	MissingParameter.ObjectType	The ObjectType parameter is required if DomainName or ObjectType is specified.
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	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	EndTime is earlier than StartTime.
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	DomainNameOverLimit	A maximum of 500 domains are supported for each request.
400	InvalidParameters	The parameters you provided are invalid.
400	InvalidTime	The query time cannot exceed the last 3 days.
429	TooManyRequests	Too many requests, please try again later

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.