単一のキャッシュ構成を取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
esa:GetCacheRule |
get |
*Site
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| 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 |
| SiteVersion |
integer |
サイト構成のバージョン番号。 バージョン管理が有効なサイトの場合、これは構成バージョンを示します。 デフォルトは 0 です。 |
1 |
| Sequence |
integer |
ルール実行順序。 値が小さいほど、優先度が高くなります。 |
1 |
| RuleEnable |
string |
ルールを有効にするかどうかを指定します。 このパラメーターは、ルール構成にのみ適用されます。 有効な値:
|
on |
| Rule |
string |
ルール内容。ユーザーリクエストに一致させるために使用される条件式です。 このパラメーターは、ルール構成にのみ適用されます。
|
(http.host eq \"video.example.com\") |
| RuleName |
string |
ルール名。 このパラメーターは、ルール構成にのみ適用されます。 |
rule_example |
| BypassCache |
string |
リクエストをキャッシュするか、キャッシュをバイパスするかを指定します。 有効な値:
|
cache_all |
| BrowserCacheMode |
string |
ブラウザキャッシュモード。 有効な値:
|
follow_origin |
| BrowserCacheTtl |
string |
ブラウザキャッシュの TTL (秒単位)。 |
300 |
| EdgeCacheMode |
string |
エッジキャッシュモード。 有効な値:
|
follow_origin |
| EdgeCacheTtl |
string |
エッジキャッシュの TTL (秒単位)。 |
300 |
| EdgeStatusCodeCacheTtl |
string |
状態コードキャッシュの TTL (秒単位)。
|
5xx=0,404=10 |
| SortQueryStringForCache |
string |
キャッシュキーを生成する前にクエリ文字列をソートするかどうかを指定します。 有効な値:
|
on |
| QueryStringMode |
string |
キャッシュキーを生成するときのクエリ文字列の処理モード。 有効な値:
|
reserve_all |
| QueryString |
string |
キャッシュキーに含める、またはキャッシュキーから除外するクエリ文字列を指定します。 複数のクエリ文字列はスペースで区切ります。 |
example |
| IncludeHeader |
string |
キャッシュキーに含めるヘッダーを指定します。 ヘッダー名 (大文字と小文字を区別しない) とその値の両方がキーに追加されます。 複数のヘッダー名はスペースで区切ります。 ヘッダー名には、次の文字を含めることができます:
|
headername1 headername2 |
| IncludeCookie |
string |
キャッシュキーに含める Cookie を指定します。 Cookie 名 (大文字と小文字を区別しない) とその値の両方がキーに追加されます。 複数の Cookie 名はスペースで区切ります。 Cookie 名には、次の文字を含めることができます:
|
cookiename1 cookiename2 |
| CacheReserveEligibility |
string |
キャッシュ保持の適格性。 これは、オリジンフェッチ中にリクエストがキャッシュ保持ノードをバイパスするかどうかを制御します。 有効な値:
|
bypass_cache_reserve |
| CheckPresenceHeader |
string |
キャッシュキーを生成するときに存在を確認するヘッダーを指定します。 指定されたヘッダーがリクエストに存在する場合、その名前 (大文字と小文字を区別しない) がキャッシュキーに追加されます。 複数のヘッダー名はスペースで区切ります。 ヘッダー名には、次の文字を含めることができます:
|
headername1 headername2 |
| CheckPresenceCookie |
string |
キャッシュキーを生成するときに存在を確認する Cookie を指定します。 指定された Cookie がリクエストに存在する場合、その名前 (大文字と小文字を区別しない) がキャッシュキーに追加されます。 複数の Cookie 名はスペースで区切ります。 Cookie 名には、次の文字を含めることができます:
|
cookiename1 cookiename2 |
| UserDeviceType |
string |
クライアントのデバイスタイプをキャッシュキーに含めるかどうかを指定します。 有効な値:
|
on |
| UserGeo |
string |
クライアントの地理的位置をキャッシュキーに含めるかどうかを指定します。 有効な値:
|
on |
| UserLanguage |
string |
クライアントの言語をキャッシュキーに含めるかどうかを指定します。 有効な値:
|
on |
| ServeStale |
string |
期限切れのコンテンツを提供するかどうかを指定します。 有効にすると、オリジンサーバーが利用できない場合に、エッジノードはキャッシュから期限切れのコンテンツを提供します。 有効な値:
|
on |
| AdditionalCacheablePorts |
string |
|
8880,2052,2086 |
| CacheDeceptionArmor |
string |
Cache Deception Armor を有効にするかどうかを指定します。 この機能は、検証済みのコンテンツのみがキャッシュされるようにすることで、Web キャッシュ汚染攻撃を軽減するのに役立ちます。 有効な値:
|
on |
| PostCache |
string |
POST キャッシュ機能を有効にするかどうかを指定します。 |
on |
| PostBodyCacheKey |
string |
POST リクエストのキャッシュキーを生成するときのボディコンテンツの処理モード。 有効な値:
|
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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。