全部产品
Search
文档中心

边缘安全加速:ListCacheRules - 查询站点缓存配置列表

更新时间:Jan 15, 2026

查询多条缓存配置。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

esa:ListCacheRules

none

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

请求参数

名称

类型

必填

描述

示例值

SiteId

integer

站点 ID,可通过调用 ListSites 接口获取。

123456****

ConfigId

integer

配置 ID。

35281609698****

ConfigType

string

配置类型,可以根据此参数查全局配置或者规则配置,取值范围:

  • global:查询全局配置。

  • rule:查询规则配置。

该参数可以不传,不传时不区分全局或者规则配置。

global

RuleName

string

规则名称。添加全局配置的时候不需要设置该参数。

test

PageNumber

integer

第几页,不传时默认为 1。

1

PageSize

integer

每页几条,最大 500,不传时默认 500。

20

SiteVersion

integer

站点的版本号。开启了版本管理的站点,可以通过该参数指定配置生效的站点版本,默认为版本 0。

1

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

36af3fcc-43d0-441c-86b1-428951dc8225

Configs

array<object>

返回体配置。

object

ConfigId

integer

配置 ID。

395386449776640

SiteVersion

integer

站点配置的版本号。开启了配置版本管理的站点,可以通过该参数指定配置生效的站点版本,默认为版本 0。

1

Sequence

integer

规则执行顺序。数值越小越优先执行。

1

RuleEnable

string

规则开关。添加全局配置的时候不需要设置该参数。取值范围:

  • on:开启。

  • off:关闭。

on

Rule

string

规则内容,使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景:

  • 匹配所有传入请求:值设置为 true

  • 匹配指定请求:值设置为自定义表达式,例如:(http.host eq "video.example.com")

(http.host eq \"video.example.com\")

RuleName

string

规则名称。添加全局配置的时候不需要设置该参数。

rule_example

ConfigType

string

配置类型,可以根据此参数查全局配置或者规则配置,取值范围:

  • global:查询全局配置。

  • rule:查询规则配置。

global

BypassCache

string

设置绕过缓存模式。取值范围:

  • cache_all:所有请求都缓存。

  • bypass_all:所有请求都绕过缓存。

cache_all

BrowserCacheMode

string

浏览器缓存模式。取值范围:

  • no_cache:不缓存。

  • follow_origin:遵循源站缓存策略。

  • override_origin:代替源站缓存策略。

no_cache

BrowserCacheTtl

string

浏览器缓存过期时间,单位是秒。

300

EdgeCacheMode

string

节点缓存模式。取值范围:

  • follow_origin:遵循源站缓存策略(如果存在),否则使用默认缓存策略。

  • no_cache:不缓存。

  • override_origin:代替源站缓存策略。

  • follow_origin_bypass:遵循源站缓存策略(如果存在),否则不缓存。

  • follow_origin_override:遵循源站缓存策略(如果存在),否则使用自定义缓存 TTL。

follow_origin

EdgeCacheTtl

string

节点缓存过期时间,单位是秒。

300

EdgeStatusCodeCacheTtl

string

状态码缓存过期时间,单位是秒。

  • 支持对指定状态码设置缓存过期时间,例如:404=10,表示对 404 状态码缓存 10 秒。

  • 支持对 4xx、5xx 系列状态码设置缓存过期时间,例如:4xx=10,表示对 400 系列的所有状态码都缓存 10 秒。

4xx=10

SortQueryStringForCache

string

查询字符串排序。取值范围:

  • on:开启。

  • off:关闭。

on

QueryStringMode

string

在生成缓存键的时候,对查询字符串的处理模式。取值范围:

  • ignore_all:全部忽略。

  • exclude_query_string:删除指定查询字符串。

  • reserve_all:默认值,全部保留。

  • include_query_string:保留指定查询字符串。

ignore_all

QueryString

string

需要保留或者删除的查询字符串,支持输入多个值,多个值之间用空格分隔。

example

IncludeHeader

string

生成缓存键的时候,包括指定的标头名称及其值,支持输入多个值,多个值之间用空格分隔。

example

IncludeCookie

string

生成缓存键的时候,包括指定的 cookie 名称及其值,支持输入多个值,多个值之间用空格分隔。

cookie_exapmle

CacheReserveEligibility

string

缓存保持资格。用于控制用户请求在回源的时候是否绕过缓存保持节点。取值范围:

  • bypass_cache_reserve:请求绕过缓存保持。

  • eligible_for_cache_reserve:符合缓存保持资格。

bypass_cache_reserve

CheckPresenceHeader

string

生成缓存键的时候,检查 header 是否存在,如果存在,则在缓存键中加入 header 名称(header 名称不区分大小写)。支持输入多个 header 名称,多个值之间用空格分隔。

headername

CheckPresenceCookie

string

生成缓存键的时候,检查 cookie 是否存在,如果存在,则在缓存键中加入 cookie 名称(cookie 名称不区分大小写)。支持输入多个 cookie 名称,多个值之间用空格分隔。

cookiename

UserDeviceType

string

生成缓存键的时候,加入客户端设备类型。取值范围:

  • on:开启。

  • off:关闭。

on

UserGeo

string

生成缓存键的时候,加入客户端地理位置。取值范围:

  • on:开启。

  • off:关闭。

on

UserLanguage

string

生成缓存键的时候,加入客户端语言类型。取值范围:

  • on:开启。

  • off:关闭。

on

ServeStale

string

响应过期缓存。开启之后,在源服务器不可用的情况下,节点依然可以使用已缓存的过期文件响应用户请求。取值范围:

  • on:开启。

  • off:关闭。

on

AdditionalCacheablePorts

string

在指定端口上开启缓存功能。取值范围:8880、2052、2082、2086、2095、2053、2083、2087、2096。

2082

CacheDeceptionArmor

string

缓存欺骗防御。用于防御 Web 缓存欺骗攻击,通过校验的缓存内容才会被缓存下来。取值范围:

  • on:开启。

  • off:关闭。

on

PostCache

string

Post 缓存功能开关。

on

PostBodyCacheKey

string

缓存键的处理模式。

ignore

PostBodySizeLimit

string

Body 大小限制,值为数字,单位是 KB,支持 1~8KB 大小的 Body,值为空的时候,默认按 8KB 生效。

1

PageNumber

integer

当前页码。

1

PageSize

integer

分页大小。

10

TotalCount

integer

记录总数。

20

TotalPage

integer

总页数。

2

示例

正常返回示例

JSON格式

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "Configs": [
    {
      "ConfigId": 395386449776640,
      "SiteVersion": 1,
      "Sequence": 1,
      "RuleEnable": "on",
      "Rule": "(http.host eq \\\"video.example.com\\\")",
      "RuleName": "rule_example",
      "ConfigType": "global",
      "BypassCache": "cache_all",
      "BrowserCacheMode": "no_cache",
      "BrowserCacheTtl": "300",
      "EdgeCacheMode": "follow_origin",
      "EdgeCacheTtl": "300",
      "EdgeStatusCodeCacheTtl": "4xx=10",
      "SortQueryStringForCache": "on",
      "QueryStringMode": "ignore_all",
      "QueryString": "example",
      "IncludeHeader": "example",
      "IncludeCookie": "cookie_exapmle",
      "CacheReserveEligibility": "bypass_cache_reserve",
      "CheckPresenceHeader": "headername",
      "CheckPresenceCookie": "cookiename",
      "UserDeviceType": "on",
      "UserGeo": "on",
      "UserLanguage": "on",
      "ServeStale": "on",
      "AdditionalCacheablePorts": "2082",
      "CacheDeceptionArmor": "on",
      "PostCache": "on",
      "PostBodyCacheKey": "ignore",
      "PostBodySizeLimit": "1"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 20,
  "TotalPage": 2
}

错误码

HTTP status code

错误码

错误信息

描述

400 InternalException Failed to call the service. Try again later or contact technical support. 调用服务失败,请稍后重试或联系客服咨询详情。
400 InvalidParameter.FunctionName The specified feature does not exist. Specify a valid feature name based on the related documentation. 您所输入的功能名称不存在,请参照功能配置文档选择正确的功能名进行操作。

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

变更历史

更多信息,参考变更详情