すべてのプロダクト
Search
ドキュメントセンター

Edge Security Acceleration:ListCacheRules

最終更新日:Jun 23, 2026

複数のキャッシュ構成を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

esa:ListCacheRules

list

*Site

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

SiteId

integer

必須

サイト ID。 ListSites 操作を呼び出して取得できます。

123456****

ConfigId

integer

任意

構成 ID。

35281609698****

ConfigType

string

任意

構成タイプ。このパラメーターを使用してグローバル構成またはルール構成をクエリできます。有効な値:

  • global: グローバル構成をクエリします。

  • rule: ルール構成をクエリします。

このパラメーターはオプションです。このパラメーターを指定しない場合、グローバル構成とルール構成の両方が返されます。

列挙値:

  • rule :

    ルール構成。

  • global :

    グローバル構成。

global

RuleName

string

任意

ルール名。グローバル構成を追加する場合、このパラメーターを設定する必要はありません。

test

PageNumber

integer

任意

ページングクエリのページ番号。値は 1 以上である必要があります。

1

PageSize

integer

任意

ページングクエリの 1 ページあたりのエントリ数。有効な値: 1~500。

20

SiteVersion

integer

任意

サイトのバージョン番号。バージョン管理が有効なサイトの場合、このパラメーターを使用して構成が効果を持つサイトバージョンを指定できます。デフォルト値: 0。

1

レスポンスフィールド

フィールド

説明

object

レスポンスのスキーマ。

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

ルールの内容。条件付きの式を使用してユーザーリクエストを照合します。グローバル構成を追加する場合、このパラメーターを設定する必要はありません。次の 2 つのシナリオがサポートされています:

  • すべての受信リクエストに一致: 値を 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 は、すべての 4xx 状態コードを 10 秒間キャッシュすることを示します。

  • 複数の状態コードのキャッシュ有効期限時間をセットできます。複数の状態コードはカンマ(,)で区切ります。

5xx=0,404=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

キャッシュキー生成時に含める指定されたヘッダー名(大文字小文字を区別しない)とその値。複数の値はスペースで区切ります。ヘッダー名は次の文字タイプをサポートしています:

  • 記号: ! # $ % & ' * + - . ^ _ ` | ~

  • 数字: 0-9

  • 文字: 小文字 a-z。

headername1 headername2

IncludeCookie

string

キャッシュキー生成時に含める指定された Cookie 名(大文字小文字を区別しない)とその値。複数の値はスペースで区切ります。Cookie 名は次の文字タイプをサポートしています:

  • 記号: ! # $ % & ' * + - . ^ _ ` | ~

  • 数字: 0-9

  • 文字: 小文字 a-z。

cookiename1 cookiename2

CacheReserveEligibility

string

キャッシュ保持の適格性。オリジンへの回帰時にユーザーリクエストがキャッシュ保持ノードをバイパスするかどうかを制御します。有効な値:

  • bypass_cache_reserve: リクエストはキャッシュ保持をバイパスします。

  • eligible_for_cache_reserve: リクエストはキャッシュ保持の対象です。

bypass_cache_reserve

CheckPresenceHeader

string

キャッシュキー生成時に、指定されたヘッダーが存在するかどうかを確認します。ヘッダーが存在する場合、その名前(大文字小文字を区別しない)がキャッシュキーに追加されます。複数のヘッダー名はスペースで区切ります。ヘッダー名は次の文字タイプをサポートしています:

  • 記号: ! # $ % & ' * + - . ^ _ ` | ~

  • 数字: 0-9

  • 文字: 小文字 a-z。

headername1 headername2

CheckPresenceCookie

string

キャッシュキー生成時に、指定された Cookie が存在するかどうかを確認します。Cookie が存在する場合、その名前(大文字小文字を区別しない)がキャッシュキーに追加されます。複数の Cookie 名はスペースで区切ります。Cookie 名は次の文字タイプをサポートしています:

  • 記号: ! # $ % & ' * + - . ^ _ ` | ~

  • 数字: 0-9

  • 文字: 小文字 a-z。

cookiename1 cookiename2

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。

  • 複数のポートはカンマ(,)で区切ります。

8880,2052,2086

CacheDeceptionArmor

string

キャッシュ欺瞞アーマー。検証に合格したコンテンツのみをキャッシュすることで、Web キャッシュ欺瞞攻撃から保護します。有効な値:

  • on: 有効。

  • off: 無効。

on

PostCache

string

POST キャッシュを有効にするかどうかを指定します。

on

PostBodyCacheKey

string

POST キャッシュのキャッシュキー処理モード。次の 2 つのモードがサポートされています:

  • md5: 本文コンテンツの MD5 ハッシュを計算し、MD5 値をキャッシュキーに追加します。

  • ignore: キャッシュキーで本文コンテンツを無視します。

ignore

PostBodySizeLimit

string

POST キャッシュの本文サイズ制限。値は KB 単位の数値です。有効な値: 1~8。このパラメーターを空のままにすると、デフォルト値の 8 KB が効果を持ちます。

1

PageNumber

integer

現在のページ番号。PageNumber リクエストパラメーターと同じです。

1

PageSize

integer

1 ページあたりのエントリ数。

10

TotalCount

integer

レコードの総数。

20

TotalPage

integer

ページの総数。

2

成功レスポンス

JSONJSON

{
  "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": "5xx=0,404=10",
      "SortQueryStringForCache": "on",
      "QueryStringMode": "ignore_all",
      "QueryString": "example",
      "IncludeHeader": "headername1 headername2",
      "IncludeCookie": "cookiename1 cookiename2",
      "CacheReserveEligibility": "bypass_cache_reserve",
      "CheckPresenceHeader": "headername1 headername2",
      "CheckPresenceCookie": "cookiename1 cookiename2",
      "UserDeviceType": "on",
      "UserGeo": "on",
      "UserLanguage": "on",
      "ServeStale": "on",
      "AdditionalCacheablePorts": "8880,2052,2086",
      "CacheDeceptionArmor": "on",
      "PostCache": "on",
      "PostBodyCacheKey": "ignore",
      "PostBodySizeLimit": "1"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 20,
  "TotalPage": 2
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。