複数のキャッシュ構成を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
esa:ListCacheRules |
list |
*Site
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| SiteId |
integer |
必須 |
サイト ID。 ListSites 操作を呼び出して取得できます。 |
123456**** |
| ConfigId |
integer |
任意 |
構成 ID。 |
35281609698**** |
| ConfigType |
string |
任意 |
構成タイプ。このパラメーターを使用してグローバル構成またはルール構成をクエリできます。有効な値:
このパラメーターはオプションです。このパラメーターを指定しない場合、グローバル構成とルール構成の両方が返されます。 列挙値:
|
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 |
| Rule |
string |
ルールの内容。条件付きの式を使用してユーザーリクエストを照合します。グローバル構成を追加する場合、このパラメーターを設定する必要はありません。次の 2 つのシナリオがサポートされています:
|
(http.host eq \"video.example.com\") |
| RuleName |
string |
ルール名。グローバル構成を追加する場合、このパラメーターを設定する必要はありません。 |
rule_example |
| ConfigType |
string |
構成タイプ。このパラメーターを使用してグローバル構成またはルール構成をクエリできます。有効な値:
|
global |
| BypassCache |
string |
バイパスキャッシュモード。有効な値:
|
cache_all |
| BrowserCacheMode |
string |
ブラウザキャッシュモード。有効な値:
|
no_cache |
| BrowserCacheTtl |
string |
ブラウザキャッシュの有効期限時間(秒単位)。 |
300 |
| EdgeCacheMode |
string |
エッジキャッシュモード。有効な値:
|
follow_origin |
| EdgeCacheTtl |
string |
エッジキャッシュの有効期限時間(秒単位)。 |
300 |
| EdgeStatusCodeCacheTtl |
string |
状態コードキャッシュの有効期限時間(秒単位)。
|
5xx=0,404=10 |
| SortQueryStringForCache |
string |
クエリ文字列をソートするかどうかを指定します。有効な値:
|
on |
| QueryStringMode |
string |
キャッシュキー生成時のクエリ文字列の処理モード。有効な値:
|
ignore_all |
| QueryString |
string |
キャッシュキー生成時に保持または削除するクエリ文字列。複数の値はスペースで区切ります。 |
example |
| IncludeHeader |
string |
キャッシュキー生成時に含める指定されたヘッダー名(大文字小文字を区別しない)とその値。複数の値はスペースで区切ります。ヘッダー名は次の文字タイプをサポートしています:
|
headername1 headername2 |
| IncludeCookie |
string |
キャッシュキー生成時に含める指定された 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 |
キャッシュ欺瞞アーマー。検証に合格したコンテンツのみをキャッシュすることで、Web キャッシュ欺瞞攻撃から保護します。有効な値:
|
on |
| PostCache |
string |
POST キャッシュを有効にするかどうかを指定します。 |
on |
| PostBodyCacheKey |
string |
POST キャッシュのキャッシュキー処理モード。次の 2 つのモードがサポートされています:
|
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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。