Queries the status of refresh or prefetch tasks by ID for an accelerated domain name.
Operation Description
NoteYou can query data within the last three days.
- You can call this operation up to 30 times per second per account.
Authorization information
The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action
Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:
- 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 keyword: refers to the condition keyword defined by the cloud product itself.
- 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.
Operate | access level | Resource type | conditional keyword | Association operation |
---|---|---|---|---|
cdn:DescribeRefreshTaskById | Read |
|
| without |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
TaskId | string | Yes | The ID of the task that you want to query. You can call the RefreshObjectCaches operation to query task IDs. Then, you can use the task IDs to query task status. You can specify up to 10 task IDs. Separate task IDs with commas (,). | 12345678 |
Response parameters
Example
Normal return example
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 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 specified start time is invalid. For more information, see the API references. |
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. | - |
400 | InvalidStartTime.ValueNotSupported | The specified StartTime is invalid. | - |
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 | InvalidTaskId.Malformed | The count of taskIds should be between 1 and 10. | - |
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 | - |
For a list of error codes, visit the API error center.