Use PreloadVodObjectCaches to prefetch VOD resources to cache - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Operation description

Currently, the only supported service region is China (Shanghai).
A maximum of 500 prefetch URL requests can be submitted per account per day. Directory-level prefetch is not supported.
The purge and prefetch operations include the RefreshVodObjectCaches purge operation and the PreloadVodObjectCaches prefetch operation.

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

vod:PreloadVodObjectCaches

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ObjectPath	string	Yes	The URL of the file to prefetch. Separate multiple URLs with line breaks (\n or \r\n).	vod.test.com/test.txt
Area	string	No	The prefetch region. Valid values: domestic, overseas.	domestic
L2Preload	boolean	No	Specifies whether to directly prefetch content to L2 nodes. Valid values: true: The prefetch node level must include L2 nodes. false: Only back-to-origin layer nodes are prefetched. This is the default value. The back-to-origin layer node may be an L2 node or an L3 node.	true
WithHeader	string	No	The default header carried in a prefetch request is Accept-Encoding:gzip. If you want the prefetch request to carry other headers or implement multi-copy prefetch, use this parameter to customize prefetch headers. Submit the value in JSON format.	{ "Accept-Encoding": [ "gzip, deflate, br" ] }

Response elements

Element	Type	Description	Example
	object	The response parameters.
PreloadTaskId	string	The task ID returned for the prefetch operation. Multiple task IDs are separated by commas (,).	9524****
RequestId	string	The request ID.	E5BD4B50-7A02-493A-*****-97B9024B4135

Examples

Success response

JSON format

{
  "PreloadTaskId": "9524****",
  "RequestId": "E5BD4B50-7A02-493A-*****-97B9024B4135"
}

Error codes

HTTP status code	Error code	Error message	Description
400	SingleRequest.OverLimit	A maximum of 1000 URLs are supported for each request.
400	QuotaExceeded.Preload	Your refresh attempts have exceeded the daily limit.
400	InvalidObjectPath.Malformed	The specified ObjectPath is invalid.	The ObjectPath parameter is invalid.
400	InvalidExtensiveDomain.ValueNotSupported	The specified ExtensiveDomain is not supported.
400	PreloadQueueFull	The warming queue is full; please try again later.
400	InvalidCustomHeader	Parse preload header failed.	Failed to parse preload header.
404	InvalidDomain.Offline	The domain provided is offline.
404	InvalidDomain.NotFound	The domain provided does not belong to you.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.