Queries the Static Page Caching configurations of websites.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeWebCacheConfigs

The operation that you want to perform. Set the value to DescribeWebCacheConfigs.

Domains.N RepeatList Yes www.aliyun.com

The domain name of website N.

Note A forwarding rule must be configured for the domain name, and the domain name must be associated with an instance that uses the enhanced function plan. You can call the DescribeDomains operation to query all domain names.
RegionId String No cn-hangzhou

The region ID of the instance. Valid values:

  • cn-hangzhou: mainland China, which indicates an Anti-DDoS Pro instance
  • ap-southeast-1: outside mainland China, which indicates an Anti-DDoS Premium instance
ResourceGroupId String No default

The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates that the instance belongs to the default resource group.

Response parameters

Parameter Type Example Description
DomainCacheConfigs Array

The configuration of the Static Page Caching policy.
CustomRules Array

Details about the custom static page caching rule.
CacheTtl Long 86400

The expiration time of the page cache. Unit: seconds.
Mode String standard

The cache mode of the rule. Valid values:

  • standard: the Standard mode
  • aggressive: the Enhanced mode
  • bypass: the No Cache mode
Name String c1

The name of the rule.
Uri String /blog/

The path to the cached page.
Domain String www.aliyun.com

The domain name of the website.
Enable Integer 1

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

  • 1: The policy is enabled.
  • 0: The policy is disabled.
Mode String bypass

The cache mode of the Static Page Caching policy. Valid values:

  • standard: the Standard mode
  • Aggressive: the Enhanced mode
  • bypass: the No Cache mode
RequestId String 0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeWebCacheConfigs
&Domains.1=www.aliyun.com
&<Common request parameters>

Sample success responses

XML format 

<DescribeWebCacheConfigsResponse>
      <RequestId>0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc</RequestId>
      <DomainCacheConfigs>
            <Domain>www.aliyun.com</Domain>
            <Enable>1</Enable>
            <Mode>bypass</Mode>
            <CustomRules>
                  <Name>c1</Name>
                  <Uri>/blog/</Uri>
                  <Mode>standard</Mode>
                  <CacheTtl>86400</CacheTtl>
            </CustomRules>
      </DomainCacheConfigs>
</DescribeWebCacheConfigsResponse>

JSON format 

{
    "RequestId": "0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc",
    "DomainCacheConfigs": [
        {
            "Domain": "www.aliyun.com",
            "Enable": 1,
            "Mode": "bypass",
            "CustomRules": [
                {
                    "Name": "c1",
                    "Uri": "/blog/",
                    "Mode": "standard",
                    "CacheTtl": 86400
                }
            ]
        }
    ]
}

Error codes

For a list of error codes, visit the API Error Center.