调用DescribeWebCacheConfigs查询网站业务静态页面缓存的配置。

使用说明

本接口用于查询网站业务静态页面缓存的配置,例如,缓存模式、自定义缓存规则等。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制,API调用将会被限流,这可能影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeWebCacheConfigs

要执行的操作。取值:DescribeWebCacheConfigs

RegionId String cn-hangzhou

DDoS高防实例所属地域ID。取值:

  • cn-hangzhou(默认):表示中国内地,即DDoS高防(新BGP)实例。
  • ap-southeast-1:表示非中国内地,即DDoS高防(国际)实例。
ResourceGroupId String rg-acfm2pz25js****

DDoS高防实例在资源管理服务中所属的资源组ID。

不设置该参数表示默认资源组。

Domains.N String www.aliyundoc.com

要查询静态页面缓配置的域名。

说明 您可以调用DescribeDomains查询所有已接入DDoS高防防护的域名。

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
RequestId String 6623EA1F-30FB-5BC8-BEC9-74D55F6F08F1

本次请求的ID。

DomainCacheConfigs Array of CacheConfig

静态页面缓存的配置信息。

Domain String www.aliyundoc.com

网站域名。

Mode String bypass

缓存模式。取值:

  • standard:表示标准模式。
  • aggressive:表示强力模式。
  • bypass:表示不缓存。
Enable Integer 1

开关状态。取值:

  • 1:表示开启。
  • 0:表示关闭。
CustomRules Array of CustomRule

自定义缓存规则配置。

Mode String standard

缓存模式。取值:

  • standard:表示标准模式。
  • aggressive:表示强力模式。
  • bypass:表示不缓存。
CacheTtl Long 86400

页面缓存的过期时间。单位:秒。

Name String c1

规则名称。

Uri String /blog/

缓存页面的路径。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeWebCacheConfigs
&Domains=["www.aliyundoc.com"]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeWebCacheConfigsResponse>
    <RequestId>6623EA1F-30FB-5BC8-BEC9-74D55F6F08F1</RequestId>
    <DomainCacheConfigs>
        <Domain>www.aliyundoc.com</Domain>
        <Mode>bypass</Mode>
        <Enable>1</Enable>
        <CustomRules>
            <Mode>standard</Mode>
            <CacheTtl>86400</CacheTtl>
            <Name>c1</Name>
            <Uri>/blog/</Uri>
        </CustomRules>
    </DomainCacheConfigs>
</DescribeWebCacheConfigsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

访问错误中心查看更多错误码。