全部產品
Search
文件中心

Edge Security Acceleration: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. 您所輸入的功能名稱不存在,請參照功能配置文檔選擇正確的功能名進行操作。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情