All Products
Search
Document Center

Anti-DDoS:DescribeWebCacheConfigs

Last Updated:Oct 23, 2024

Queries the Static Page Caching configuration of websites.

Operation description

You can call the DescribeWebCacheConfigs operation to query the Static Page Caching configurations of websites. The configurations include cache modes and custom caching rules.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
yundun-ddoscoo:DescribeWebCacheConfigsget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceGroupIdstringNo

The ID of the resource group to which the instance belongs in Resource Management.

If you do not configure this parameter, the instance belongs to the default resource group.

rg-acfm2pz25js****
DomainsarrayYes

An array consisting of domain names for which you want to query the Static Page Caching configurations.

stringYes

The domain name for which you want to query the Static Page Caching configurations.

Note You can call the DescribeDomains operation to query all the domain names that are added to Anti-DDoS Pro or Anti-DDoS Premium.
www.aliyundoc.com

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

6623EA1F-30FB-5BC8-BEC9-74D55F6F08F1
DomainCacheConfigsarray<object>

An array that consists of Static Page Caching configurations.

CacheConfigobject
Domainstring

The domain name of the website.

www.aliyundoc.com
Modestring

The cache mode. Valid values:

  • standard: The standard cache mode is used.
  • aggressive: The enhanced cache mode is used.
  • bypass: No data is cached.
bypass
Enableinteger

The status of the Static Page Caching policy. Valid values:

  • 1: enabled
  • 0: disabled
1
CustomRulesarray<object>

An array that consists of custom caching rules.

CustomRuleobject
Modestring

The cache mode. Valid values:

  • standard: The standard cache mode is used.
  • aggressive: The enhanced cache mode is used.
  • bypass: No data is cached.
standard
CacheTtllong

The expiration time of the page cache. Unit: seconds.

86400
Namestring

The name of the rule.

c1
Uristring

The path to the cached page.

/blog/

Examples

Sample success responses

JSONformat

{
  "RequestId": "6623EA1F-30FB-5BC8-BEC9-74D55F6F08F1",
  "DomainCacheConfigs": [
    {
      "Domain": "www.aliyundoc.com",
      "Mode": "bypass",
      "Enable": 1,
      "CustomRules": [
        {
          "Mode": "standard",
          "CacheTtl": 86400,
          "Name": "c1",
          "Uri": "/blog/"
        }
      ]
    }
  ]
}

Error codes

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