All Products
Search
Document Center

ApsaraVideo VOD:DescribeVodRefreshQuota

Last Updated:Nov 09, 2022

Queries the maximum number and remaining number of requests to refresh or prefetch files on the current day. You can prefetch files based on URLs and refresh files based on URLs or directories.

Operation Description

Note
  • This operation is available only in the China (Shanghai) region.
  • 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:DescribeVodRefreshQuotaRead
    • VOD
      acs:vod:*:{#accountId}:*
      without
    without

    Request parameters

    ParameterTypeRequiredDescriptionExample
    The current API does not require request parameters

    Response parameters

    ParameterTypeDescriptionExample
    object
    BlockQuotastring

    The maximum number of Object Storage Service (OSS) buckets that can be refreshed each day.

    500
    PreloadRemainstring

    The remaining number of URLs of files that can be prefetched on the current day.

    500
    RequestIdstring

    The ID of the request.

    42E0554B-80F4-4921-****-ACFB22CAAAD0
    blockRemainstring

    The remaining number of OSS buckets that can be refreshed on the current day.

    500
    DirRemainstring

    The remaining number of directories of files that can be refreshed on the current day.

    99
    UrlRemainstring

    The remaining number of URLs of files that can be refreshed on the current day.

    1996
    DirQuotastring

    The maximum number of directories of files that can be refreshed each day.

    100
    UrlQuotastring

    The maximum number of URLs of files that can be refreshed each day.

    2000
    PreloadQuotastring

    The maximum number of URLs of files that can be prefetched each day.

    500

    Example

    Normal return example

    JSONFormat

    {
      "BlockQuota": "500",
      "PreloadRemain": "500",
      "RequestId": "42E0554B-80F4-4921-****-ACFB22CAAAD0",
      "blockRemain": "500",
      "DirRemain": "99",
      "UrlRemain": "1996",
      "DirQuota": "100",
      "UrlQuota": "2000",
      "PreloadQuota": "500"
    }

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