All Products
Search
Document Center

Alibaba Cloud CDN:DescribeRefreshQuota

Last Updated:Jan 13, 2023

Queries the maximum and remaining numbers of URLs and directories that can be refreshed, the maximum and remaining numbers of times that you can prefetch content, and the maximum and remaining numbers of URLs and directories that can be blocked on the current day.

Operation Description

Note
  • You can call the RefreshObjectCaches operation to refresh content and call the PushObjectCache operation to prefetch content.
    • The maximum number of times that each user can call this operation per second is 20.

    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.
    Operate access level Resource type conditional keyword Association operation
    cdn:DescribeRefreshQuota Read
    • CDN
      acs:cdn:*:{#accountId}:*
      without
    without

    Request parameters

    Parameter Type Required Description Example
    The current API does not require request parameters

    Response parameters

    Parameter Type Description Example
    object
    PreloadRemain string

    The remaining number of times that you can prefetch content to L2 nodes on the current day.

    400
    BlockRemain string

    The remaining number of URLs and directories that can be blocked on the current day.

    100
    RegexRemain string

    The remaining number of times that you can use regular expressions to refresh directories or URLs on the current day.

    10
    UrlRemain string

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

    1996
    DirRemain string

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

    99
    UrlQuota string

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

    2000
    BlockQuota string

    The maximum number of URLs and directories that can be blocked on the current day.

    300
    RequestId string

    The ID of the request

    42E0554B-80F4-4921-AED6-ACFB22CAAAD0
    DirQuota string

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

    100
    PreloadEdgeQuota string

    The maximum number of times that you can prefetch content to L1 nodes on the current day.

    20
    PreloadEdgeRemain string

    The remaining number of times that you can prefetch content to L1 nodes on the current day.

    20
    PreloadQuota string

    The maximum number of times that you can prefetch content to L2 nodes on the current day.

    500
    RegexQuota string

    The maximum number of times that you can use regular expressions to refresh directories or URLs on the current day.

    20

    Example

    Normal return example

    JSONFormat

    {
      "PreloadRemain": "400",
      "BlockRemain": "100",
      "RegexRemain": "10",
      "UrlRemain": "1996",
      "DirRemain": "99",
      "UrlQuota": "2000",
      "BlockQuota": "300",
      "RequestId": "42E0554B-80F4-4921-AED6-ACFB22CAAAD0",
      "DirQuota": "100",
      "PreloadEdgeQuota": "20",
      "PreloadEdgeRemain": "20",
      "PreloadQuota": "500",
      "RegexQuota": "20"
    }

    Error codes

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