All Products
Search
Document Center

ApsaraVideo VOD:PreloadVodObjectCaches

Last Updated:Dec 14, 2022

Prefetches resources from an origin server to L2 nodes. Users can directly hit the cache upon their first visits. This way, workloads on the origin server can be reduced.

Operation Description

Note
  • This operation is available only in the China (Shanghai) region.
  • You can submit a maximum of 500 requests to prefetch resources based on URLs each day by using an Alibaba Cloud account. You cannot prefetch resources based on directories.
  • You can call the RefreshVodObjectCaches operation to refresh content and the PreloadVodObjectCaches operation to prefetch content.
  • 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.
    Operateaccess levelResource typeconditional keywordAssociation operation
    vod:PreloadVodObjectCachesList
    • VOD
      acs:vod:*:{#accountId}:*/*
      without
    without

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ObjectPathstringYes

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

    vod.test.com/test.txt

    Response parameters

    ParameterTypeDescriptionExample
    object
    PreloadTaskIdstring

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

    9524****
    RequestIdstring

    The ID of the request.

    E5BD4B50-7A02-493A-*****-97B9024B4135

    Example

    Normal return example

    JSONFormat

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

    Error codes

    For a list of error codes, visit the API error center.

    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. If you do not settle your overdue payments within 15 days, you must re-activate ApsaraVideo VOD after you settle all the overdue payments.
    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.
    PreloadQueueFullPreload queue is full, please try again later!403The error message returned because the number of URLs of the files being prefetched has reached the upper limit. 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.
    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.
    InvalidObjectPath.Size.MalformedThe size of ObjectPath is bigger than 1000.400The error message returned because a maximum of 1,000 URLs of files can be prefetched at a time.