GET cache_setting
API情報
| HTTPメソッド | API名 | 目的 |
|---|---|---|
| GET | cache_setting | キャッシュ設定情報取得 |
- キャッシュの設定情報を取得します。
個別パラメータ
URL
| フィールド | タイプ | 意味 |
|---|---|---|
| UrlScheme | String | URLスキーム 値: http, https |
HTTPリクエストボディ
- なし
レスポンス
| フィールド | タイプ | 意味 |
|---|---|---|
| Result.UrlScheme | String | URLスキーム 値: http, https |
| Result.QueryType | String | クエリストリング付きアクセスの取り扱い設定 (no-cache: クエリストリング付アクセスをキャッシュしない、all-cache: クエリストリング付アクセスをすべてキャッシュする、key-cache: キャッシュするクエリパラメータ名を指定する) 値: no-cache, all-cache, key-cache |
| Result.CachedKey | String | キャッシュ対象のクエリストリングパラメタ文字列
|
| Result.QueryType2 | String | クエリストリング付きアクセスのキャッシュ区別設定 (none: クエリパラメータにより区別しない、include: 区別するクエリパラメータ名を指定する、all: すべてのクエリパラメータを区別する) 値: none, include, all |
| Result.CachedKey2 | String | クエリストリング付きアクセスのキャッシュ区別の対象となるクエリストリングパラメタ文字列
|
| Result.CacheTtl | Array | キャッシュルール設定
|
| Result.CacheTtl.Path | String | URLパス
|
| Result.CacheTtl.SubDirectory | String | 前方一致するすべてのファイルをキャッシュする場合は配下(on)、URLと完全一致するファイルのみをキャッシュする場合は直下(off) 値: on, off
|
| Result.CacheTtl.Extension | String | キャッシュするファイルの拡張子
|
| Result.CacheTtl.CacheType | String | コンテンツのキャッシュ方法 (validate: キャッシュする、ignore-server-nocache:no-cacheレスポンスヘッダを無視してキャッシュする、invalidate: キャッシュしない) 値: validate, ignore-server-nocache, invalidate |
| Result.CacheTtl.Ttl | String | キャッシュ更新までの時間(キャッシュTTL)
|
| Result.CacheTtl.TextCookieCache | String | リクエストにCookieが含まれている場合にContent-Typeがテキストのコンテンツをキャッシュする場合は "on"、キャッシュしない場合は "off"
|
| Result.CacheTtl.IgnoreClientNocache | String | no-cache付きリクエストをキャッシュする場合は"on"、キャッシュしない場合は"off" |
| Result.CacheTtl.RemoveQueryString | String | クエリストリングを削除する場合は"on"、削除しない場合は"off" |
| Result.CacheTtlBase.TextCookieCache | String | "on"の場合、Result.CacheTtl.TextCookieCache の設定に関わらず、全てのURLに「リクエストにCookieが含まれている場合にContent-Typeがテキストのコンテンツをキャッシュする」 が適用
|
| Result.CacheTtlBase.IgnoreClientNocache | String | "on"の場合、Result.CacheTtl.IgnoreClientNocacheの設定に関わらず、全てのURLに 「no-cache付きリクエストをキャッシュする」 が適用 |
| Result.CacheTtlBase.RemoveQueryString | String | "on"の場合、Result.CacheTtl.RemoveQueryStringが"off"ではない全てのURLに 「クエリストリングの削除機能」 が適用 |
| Result.HttpsCache | String | HTTPSコンテンツのキャッシュ方法
|
| Result.SslV3 | String | HTTPS通信でSSL 3.0が有効である場合は"on"、無効である場合は"off" 値: on, off
|
| Result.TlsV10 | String | HTTPS通信でTLS 1.0が有効である場合は"on"、無効である場合は"off" 値: on, off
|
| Result.TlsV11 | String | HTTPS通信でTLS 1.1が有効である場合は"on"、無効である場合は"off" 値: on, off
|
| Result.TlsV12 | String | HTTPS通信でTLS 1.2が有効である場合は"on"、無効である場合は"off" 値: on, off
|
| Result.TlsV13 | String | HTTPS通信でTLS 1.3が有効である場合は"on"、無効である場合は"off" 値: on, off
|
| Result.Cbc | String | HTTPS通信でCBCモードを用いる暗号化スイートが有効である場合は"on"、無効である場合は"off"
|
エラーコード
- このAPIに関する個別エラーはありません。
- 共通エラーコードはエラーレスポンスを参照してください。
制限
- なし
サンプル
リクエスト
GET /r/(APIVersion)/(ServiceCode)/(UrlScheme)/cache_setting.json Host: cac.api.iij.jp Date: Mon, dd Jan 20yy 12:34:56 GMT x-iijapi-Expire: (Expire) x-iijapi-SignatureMethod: (SignatureMethod) x-iijapi-SignatureVersion: (SignatureVersion) Authorization: IIJAPI (AccessKeyId):(Signature)
レスポンスボディ
{
"Result": {
"RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
"ServiceCode": "cac########",
"UrlScheme":"https",
"QueryType":"all-cache",
"CachedKey":"",
"CacheTtl":
[
{
"Path":"example",
"SubDirectory":"off",
"Extension":"",
"CacheType":"validate",
"Ttl":"300",
"TextCookieCache":"on",
"IgnoreClientNocache":"on",
"RemoveQueryString":"on"
},
{
"Path":"example/js",
"SubDirectory":"on",
"Extension":"js",
"CacheType":"validate",
"Ttl":"1440",
"TextCookieCache":"on",
"IgnoreClientNocache":"on",
"RemoveQueryString":"on"
},
{
"Path":"example",
"SubDirectory":"on",
"Extension":"",
"CacheType":"invalidate",
"Ttl":"-1",
"TextCookieCache":"off",
"IgnoreClientNocache":"off",
"RemoveQueryString":"off"
}
],
"CacheTtlBase":
{
"TextCookieCache":"off",
"IgnoreClientNocache":"off",
"RemoveQueryString":"off"
},
"HttpsCache":"off",
"SslV3":"off",
"Tls10":"off",
"Tls11":"off",
"Tls12":"on",
"Tls13":"on",
"Cbc":"on"
}
}