Queries the status of refresh or prefetch tasks that belong to an accelerated domain name.
Operation description
- You can query the status of tasks by task ID or URL.
- You can set both the TaskId and ObjectPath parameters. If you do not set the TaskId or ObjectPath parameter, data entries on the first page (20 entries) collected in the last 3 days are returned.
- You can query data collected in the last 3 days.
- If auto CDN cache update is enabled in the Object Storage Service (OSS) console, you cannot call the DescribeRefreshTasks operation to query automatic refresh tasks in OSS.
- You can call this operation up to 10 times per second per account. If you want to query tasks at a higher frequency, call the DescribeRefreshTaskById operation. This operation allows you to query tasks by task ID.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
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 that you want to query. | 1234321 |
ObjectPath | string | No | The path of the object. The path is used as a condition for exact matching. | 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 type of the task. Valid values:
Note
If you set the DomainName or Status parameter, you must also set the ObjectType parameter.
| file |
DomainName | string | No | The accelerated domain name. You can specify only one accelerated domain name in each call. By default, this operation queries the status of tasks for all accelerated domain names. | example.com |
Status | string | No | The status of the task. Valid values:
| Complete |
PageSize | integer | No | The number of entries to return on each page. Default value: 20. Maximum value: 100. Valid values: 1 to 100. | 20 |
StartTime | string | No | The start of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2017-12-21T08:00: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. Note
The end time must be later than the start time.
| 2017-12-22T08:00:00Z |
ResourceGroupId | string | No | The ID of the resource group. | rg-acfmyuji4b6r4** |
Response parameters
Examples
Sample success responses
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. | - |
429 | TooManyRequests | The server is busy. Please try again later. | The server is busy. Please try again later. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-02-22 | The Error code has changed | View Change Details |
2023-03-29 | The Error code has changed | View Change Details |