ListCacheRules - 查询站点缓存配置列表

查询多条缓存配置。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
SiteIdlong

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

123456****
ConfigIdlong

配置 ID。

35281609698****
ConfigTypestring

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

  • global:查询全局配置。
  • rule:查询规则配置。

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

global
RuleNamestring

规则名,可以查出规则名为所传字段的那条规则。

test
PageNumberinteger

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

1
PageSizeinteger

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

20
SiteVersioninteger

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

1

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

36af3fcc-43d0-441c-86b1-428951dc8225
Configsarray<object>

返回体配置。

configsobject
ConfigIdlong

配置 ID。

395386449776640
SiteVersioninteger

站点的版本号。

1
Sequenceinteger

规则执行顺序。

1
RuleEnablestring

规则开关。取值范围:

  • on:开启。
  • off:关闭。
on
Rulestring

规则内容。

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

规则名称。

rule_example
ConfigTypestring

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

  • global:查询全局配置。
  • rule:查询规则配置。
global
BypassCachestring

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

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

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

  • no_cache:不缓存。
  • follow_origin:遵循源站缓存策略。
  • override_origin:代替源站缓存策略。
no_cache
BrowserCacheTtlstring

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

300
EdgeCacheModestring

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

  • follow_origin:遵循源站缓存策略(如果存在),否则使用默认缓存策略。
  • no_cache:不缓存。
  • override_origin:代替源站缓存策略。
  • follow_origin_bypass:遵循源站缓存策略(如果存在),否则不缓存。
follow_origin
EdgeCacheTtlstring

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

300
EdgeStatusCodeCacheTtlstring

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

300
SortQueryStringForCachestring

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

  • on:开启。
  • off:关闭。
on
QueryStringModestring

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

  • ignore_all:全部忽略。
  • exclude_query_string:删除指定查询字符串。
  • reserve_all:默认值,全部保留。
  • include_query_string:保留指定查询字符串。
ignore_all
QueryStringstring

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

example
IncludeHeaderstring

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

example
IncludeCookiestring

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

cookie_exapmle
CacheReserveEligibilitystring

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

  • bypass_cache_reserve:请求绕过缓存保持。
  • eligible_for_cache_reserve:符合缓存保持资格。
bypass_cache_reserve
CheckPresenceHeaderstring

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

headername
CheckPresenceCookiestring

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

cookiename
UserDeviceTypestring

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

  • on:开启。
  • off:关闭。
on
UserGeostring

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

  • on:开启。
  • off:关闭。
on
UserLanguagestring

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

  • on:开启。
  • off:关闭。
on
ServeStalestring

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

  • on:开启。
  • off:关闭。
on
AdditionalCacheablePortsstring

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

2082
CacheDeceptionArmorstring

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

  • on:开启。
  • off:关闭。
on
PageNumberinteger

当前页码。

1
PageSizeinteger

分页大小。

10
TotalCountinteger

记录总数。

20
TotalPageinteger

总页数。

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": "300",
      "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"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 20,
  "TotalPage": 2
}

错误码

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

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