Queries the information about one or more refresh or prefetch tasks.
Operation description
-
This operation is available only in the China (Shanghai) region.
-
If you do not specify the TaskId or ObjectPath parameter, the data in the last three days is returned on the first page. By default, one page displays a maximum of 20 entries. You can specify the TaskId and ObjectPath parameters at the same time.
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 |
---|---|---|---|---|
vod:DescribeVodRefreshTasks | list | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
TaskId | string | No | The ID of the task that you want to query. | 70422**** |
ObjectPath | string | No | The path of the object. The path is used as a condition for exact matching. | http://example.com/***.txt |
PageNumber | integer | No | The page number. | 1 |
ObjectType | string | No | The type of the task. Valid values:
Note
If you specify the DomainName or Status parameter, you must also specify the ObjectType parameter.
| file |
DomainName | string | No | The domain name. | 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: 50. | 20 |
StartTime | string | No | The beginning 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. Note
You can query data that is collected in the last three days.
| 2017-01-01T12:12:20Z |
EndTime | string | No | The end 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-01-01T12:30:20Z |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "174F6032-AA26-470D-****-36F0EB205BEE",
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 2,
"Tasks": {
"Task": [
{
"Status": "Complete",
"CreationTime": "2014-11-27T08:23:22Z",
"ObjectType": "file",
"Process": "100%",
"Description": "Internal Error",
"ObjectPath": "http://example.com/****.txt",
"TaskId": "704225667"
}
]
}
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-06-06 | The Error code has changed | View Change Details |
Common errors
The following table describes the error codes that this operation can return.
Error code | Error message | HTTP status code | Description |
---|---|---|---|
Throttling | Request was denied due to request throttling. | 503 | The error message returned because the request was denied due to throttling. |
OperationDenied | Your account does not open VOD service yet. | 403 | The error message returned because ApsaraVideo VOD is not activated for your Alibaba Cloud account. |
OperationDenied.Suspended | Your VOD service is suspended. | 403 | The error message returned because your Alibaba Cloud account has overdue payments. Add funds to your account. |
InvalidTaskId.Malformed | Specified TaskId is malformed. | 400 | The error message returned because the value of the TaskId parameter is in an invalid format. |