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

Edge Security Acceleration:GetCacheRule

最終更新日:Apr 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:GetCacheRule

get

*Site

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

SiteId

integer

必須

サイト ID。 この ID を取得するには、ListSites 操作を呼び出します。

123456****

ConfigId

integer

必須

構成 ID。 この ID を取得するには、ListCacheRules 操作を呼び出します。

352816096987136

レスポンスフィールド

フィールド

説明

object

応答のスキーマ。

RequestId

string

リクエスト ID。

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

ConfigId

integer

構成 ID。

352816096987136

ConfigType

string

応答にグローバル構成とルール構成のどちらが含まれるかを示します。 有効な値:

  • global:グローバル構成。

  • rule:ルール構成。

global

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

BypassCache

string

リクエストをキャッシュするか、キャッシュをバイパスするかを指定します。 有効な値:

  • cache_all:すべてのリクエストをキャッシュします。

  • bypass_all:すべてのリクエストでキャッシュをバイパスします。

cache_all

BrowserCacheMode

string

ブラウザキャッシュモード。 有効な値:

  • no_cache:コンテンツをキャッシュしません。

  • follow_origin:オリジンキャッシュポリシーに従います。

  • override_origin:オリジンキャッシュポリシーをオーバーライドします。

follow_origin

BrowserCacheTtl

string

ブラウザキャッシュの TTL (秒単位)。

300

EdgeCacheMode

string

エッジキャッシュモード。 有効な値:

  • follow_origin:オリジンサーバーのキャッシュポリシーを使用します。 指定されていない場合は、デフォルトポリシーが適用されます。

  • no_cache:コンテンツをキャッシュしません。

  • override_origin:オリジンキャッシュポリシーをオーバーライドします。

  • follow_origin_bypass:オリジンサーバーのキャッシュポリシーを使用します。 指定されていない場合、コンテンツはキャッシュされません。

  • follow_origin_override:オリジンサーバーのキャッシュポリシーを使用します。 指定されていない場合は、カスタムキャッシュ TTL が適用されます。

follow_origin

EdgeCacheTtl

string

エッジキャッシュの TTL (秒単位)。

300

EdgeStatusCodeCacheTtl

string

状態コードキャッシュの TTL (秒単位)。

  • 特定の状態コードのキャッシュ TTL を設定します。 たとえば、404=10 は、404 状態コードの応答が 10 秒間キャッシュされることを指定します。

  • 4xx や 5xx などの状態コードクラスのキャッシュ TTL を設定します。 たとえば、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:指定されたクエリ文字列を含めます。

reserve_all

QueryString

string

キャッシュキーに含める、またはキャッシュキーから除外するクエリ文字列を指定します。 複数のクエリ文字列はスペースで区切ります。

example

IncludeHeader

string

キャッシュキーに含めるヘッダーを指定します。 ヘッダー名 (大文字と小文字を区別しない) とその値の両方がキーに追加されます。 複数のヘッダー名はスペースで区切ります。 ヘッダー名には、次の文字を含めることができます:

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

  • 数字:0-9

  • 文字:英小文字 a-z

headername1 headername2

IncludeCookie

string

キャッシュキーに含める Cookie を指定します。 Cookie 名 (大文字と小文字を区別しない) とその値の両方がキーに追加されます。 複数の 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

  • キャッシュが有効になっている追加のポート。

  • 有効な値:888020522082208620952053208320872096

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

8880,2052,2086

CacheDeceptionArmor

string

Cache Deception Armor を有効にするかどうかを指定します。 この機能は、検証済みのコンテンツのみがキャッシュされるようにすることで、Web キャッシュ汚染攻撃を軽減するのに役立ちます。 有効な値:

  • on:有効。

  • off:無効。

on

PostCache

string

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

on

PostBodyCacheKey

string

POST リクエストのキャッシュキーを生成するときのボディコンテンツの処理モード。 有効な値:

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

  • ignore:キャッシュキーのボディコンテンツを無視します。

ignore

PostBodySizeLimit

string

POST キャッシュのボディコンテンツのサイズ制限 (KB 単位)。 値は 1 から 8 までの整数です。 null または空の値は、デフォルトで 8 KB になります。

1

成功レスポンス

JSONJSON

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "ConfigId": 352816096987136,
  "ConfigType": "global",
  "SiteVersion": 1,
  "Sequence": 1,
  "RuleEnable": "on",
  "Rule": "(http.host eq \\\"video.example.com\\\")\n",
  "RuleName": "rule_example\n",
  "BypassCache": "cache_all",
  "BrowserCacheMode": "follow_origin",
  "BrowserCacheTtl": "300",
  "EdgeCacheMode": "follow_origin",
  "EdgeCacheTtl": "300",
  "EdgeStatusCodeCacheTtl": "5xx=0,404=10",
  "SortQueryStringForCache": "on",
  "QueryStringMode": "reserve_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"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InternalException Failed to call the service. Try again later or contact technical support.

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

変更履歴

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