DescribeVodRefreshTasks - ApsaraVideo VOD - Alibaba Cloud Documentation Center

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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: file: refreshes one or more files. directory: refreshes files in the specified directories. preload: prefetches one or more files. 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: The task is complete. Refreshing: The task is in progress. Failed: The task failed.	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

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	174F6032-AA26-470D-****-36F0EB205BEE
PageNumber	long	The page number of the returned page.	1
PageSize	long	The number of entries returned per page.	10
TotalCount	long	The total number of entries returned.	2
Tasks	array<object>	The information about the returned tasks.
	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. Pending: The task is pending.	Complete
CreationTime	string	The time when the task was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2014-11-27T08:23:22Z
ObjectType	string	The type of the task. Default value: file. Valid values: file: refreshes one or more files. directory: refreshes files in the specified directory. preload: prefetches one or more files.	file
Process	string	The progress of the task in percentage.	100%
Description	string	The type of error returned when the refresh or prefetch task failed. Valid values: Valid values: Internal Error: An internal error occurred. Origin Timeout: The response from the origin server timed out. Origin Return StatusCode 5XX: The origin server returned an HTTP status code 5xx.	Internal Error
ObjectPath	string	The URL of the object refreshed.	http://example.com/****.txt
TaskId	string	The ID of the task.	704225667

Examples

Sample success responses

JSONformat

{
  "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.