All Products
Search
Document Center

ApsaraVideo VOD:RefreshVodObjectCaches

Last Updated:May 22, 2024

Refreshes files on Alibaba Cloud CDN nodes. You can refresh multiple files at a time based on URLs.

Operation description

  • This operation is available only in the China (Shanghai) region.

  • You can submit a maximum of 2,000 requests to refresh resources based on URLs and 100 requests to refresh resources based on directories each day by using an Alibaba Cloud account.

  • You can call the RefreshVodObjectCaches operation to refresh content and the PreloadVodObjectCaches operation to prefetch content.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
vod:RefreshVodObjectCachesList
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ObjectPathstringYes

The URL of the file to be prefetched. Separate multiple URLs with line breaks (\n or \r\n).

abc.com/image/1.png
ObjectTypestringNo

The type of the object that you want to refresh. Valid values:

  • File (default): refreshes one or more files.
  • Directory: refreshes the files in specified directories.
File
ForcebooleanNo

Specifies whether to refresh resources in a directory if the resources are different from the resources in the same directory in the origin server. Default value: false.

  • true:refresh all resources in the directory.

  • false:refresh the changed resources in the directory.

false

Response parameters

ParameterTypeDescriptionExample
object
RefreshTaskIdstring

The ID of the refresh task. Separate multiple task IDs with commas (,).

70422*****2904
RequestIdstring

The request ID.

D61E4801-EAFF-4A63-****-FBF6CE1CFD1C

Examples

Sample success responses

JSONformat

{
  "RefreshTaskId": "70422*****2904",
  "RequestId": "D61E4801-EAFF-4A63-****-FBF6CE1CFD1C"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-04-11The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Force

Common errors

The following table describes the common errors that this operation can return.

Error codeError messageHTTP status codeDescription
ThrottlingRequest was denied due to request throttling.503The error message returned because the request was denied due to throttling.
IllegalOperationIllegal domain operate is not permitted.403The error message returned because the domain name is invalid.
OperationDeniedYour account does not open VOD service yet.403The error message returned because ApsaraVideo VOD has not been activated for your Alibaba Cloud account.
OperationDenied.SuspendedYour VOD service is suspended.403The error message returned because your Alibaba Cloud account has overdue payments. Add funds to your account.
InvalidDomain.NotFoundThe domain provided does not belong to you.404The error message returned because the domain name does not exist or does not belong to you.
InvalidDomain.OfflineThe domain provided is offline.404The error message returned because the domain name has been disabled.
QuotaExceeded.RefreshYou’ve exceeded the prescribed refresh limits.400The error message returned because the number of requests to refresh or prefetch the content exceeds the upper limit on the current day.
ServiceBusyThe specified Domain is configuring, please retry later.403The error message returned because the domain name is being configured. Try again later.
InvalidDomain.Configure_failedFailed to configure the provided domain.500The error message returned because the system failed to configure the domain name and cannot refresh or prefetch the content.
MissingParameterThe input parameter “ObjectPath” that is mandatory for processing this request is not supplied.400The error message returned because the ObjectPath parameter is not specified.
InvalidObjectType.ValueNotSupportedThe specified value of "" is not supported.400The error message returned because the value of the ObjectType parameter is invalid.
InvalidObjectPath.MalformedThe specific value of parameter ObjectPath is malformed.400The error message returned because the value of the ObjectPath parameter is in an invalid format.
InvalidExtensiveDomain.ValueNotSupportedExtensive domain not supported.400The error message returned because the domain name contains a wildcard character.
QuotaPerMinuteExceeded.RefreshYou’ve exceeded the prescribed refresh limits per minute.400The error message returned because the number of requests to refresh the content exceeds the upper limit per minute.