PUT cache
API情報
HTTPメソッド | API名 | 目的 |
---|---|---|
PUT | cache_setting | キャッシュ設定 |
- キャッシュの動作を設定をします。
個別パラメータ
URL
フィールド | タイプ | 意味 |
---|---|---|
UrlScheme | String | URLスキーム 値: http, https |
HTTPリクエストボディ
- QueryTypeのみを変更する場合は、QueryTypeとCachedKey のみをパラメータに設定します。
- CacheTtlのみを変更する場合は、CachTtlのみをパラメータに設定します。
- CacheTtlに、[]をセットするとキャッシュのTTL設定がクリアされます。
リクエスト
フィールド | タイプ | 意味 |
---|---|---|
QueryType | String | クエリストリング付きアクセスの取り扱い設定 (no-cache: クエリストリング付アクセスをキャッシュしない, all-cache: クエリストリング付アクセスをすべてキャッシュする, key-cache: キャッシュするクエリパラメータ名を指定する) 値: no-cache, all-cache, key-cache |
CachedKey | String | キャッシュ対象のクエリストリングパラメタ文字列
|
QueryTypeV2 | String | クエリストリング付きアクセスのキャッシュ区別設定 (none: クエリパラメータにより区別しない、include: 区別するクエリパラメータ名を指定する、all: すべてのクエリパラメータを区別する) 値: none, include, all |
CachedKeyV2 | String | クエリストリング付きアクセスのキャッシュ区別の対象となるクエリストリングパラメタ文字列
|
CacheTtl | Array | キャッシュ設定
|
CacheTtl.Path | String | URLパス
特殊記号の詳細は以下となる
|
CacheTtl.UseGlob | String | URLパスで拡張指定をする場合は"on", 通常指定の場合は"off" |
CacheTtl.SubDirectory | String | 配下/直下 (on: 前方一致するすべてのファイルをキャッシュする(配下), off: URLと完全一致するファイルのみをキャッシュする(直下)) 値: on, off
|
CacheTtl.Extension | String | キャッシュするファイルの拡張子
|
CacheTtl.CacheType | String | コンテンツのキャッシュ方法 (validate: キャッシュする, ignore-server-nocache:no-cacheレスポンスヘッダを無視してキャッシュする, invalidate: キャッシュしない) 値: validate, ignore-server-nocache, invalidate |
CacheTtl.Ttl | String | キャッシュ更新までの時間(キャッシュTTL)
|
CacheTtl.TextCookieCache | String | リクエストにCookieが含まれている場合にContent-Typeがテキストのコンテンツのキャッシュ可否(on: キャッシュする, off: キャッシュしない)
|
CacheTtl.IgnoreClientNocache | String | no-cache付きリクエストのキャッシュ可否(on: キャッシュする, off: キャッシュしない)
|
CacheTtl.RemoveQueryString | String | クエリストリングを削除可否(on: キャッシュする, off: キャッシュしない)
|
CacheTtlBase.TextCookieCache | String | "on"にした場合、Result.CacheTtl.TextCookieCache の設定に関わらず、全てのURLに「リクエストにCookieが含まれている場合にContent-Typeがテキストのコンテンツをキャッシュする」が適用されます。 値: on, off |
CacheTtlBase.IgnoreClientNocache | String | "on"にした場合、Result.CacheTtl.IgnoreClientNocache の設定に関わらず、全てのURLに 「no-cache付きリクエストをキャッシュする」が適用されます。 値: on, off |
CacheTtlBase.RemoveQueryString | String | "on"にした場合、Result.CacheTtl.RemoveQueryStringが"off"ではない全てのURLに 「クエリストリングの削除機能」 が適用されます。 |
HttpsCache | String | HTTPSコンテンツのキャッシュ方法 値: on, off
|
Cbc | String | TPS通信でCBCモードを用いる暗号化スイートが有効である場合は"on"、無効である場合は"off"
|
レスポンス
フィールド | タイプ | 意味 |
---|---|---|
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.QueryTypeV2 | String | クエリストリング付きアクセスのキャッシュ区別設定 (none: クエリパラメータにより区別しない、include: 区別するクエリパラメータ名を指定する、all: すべてのクエリパラメータを区別する) 本レスポンスフィールドは新設備のみとなります 値: none, include, all |
Result.CachedKeyV2 | String | クエリストリング付きアクセスのキャッシュ区別の対象となるクエリストリングパラメタ文字列 本レスポンスフィールドは新設備のみとなります
|
Result.CacheTtl | Array | キャッシュ設定
|
Result.CacheTtl.Path | String | URLパス
|
Result.CacheTtl.UseGlob | String | URLパスで拡張指定をする場合は"on", 通常指定の場合は"off" |
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がテキストのコンテンツをキャッシュする」 が適用 値: on, off
|
Result.CacheTtlBase.IgnoreClientNocache | String | "on"の場合、Result.CacheTtl.IgnoreClientNocache の設定に関わらず、全てのURLに「no-cache付きリクエストをキャッシュする」が適用 値: on, off |
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に関する個別エラーはありません。
- 共通エラーコードはエラーレスポンスを参照してください。
制限
- CacheTtl.Path, CachTtl.SubDirectory, CachTtl.Ttlが同一の設定を複数指定することはできません。
- CacheTtl.CacheTypeに、"invalidate"(キャッシュしない)を設定した場合は、CacheTtl.SubDirectoryに"on"、CacheTtl.Ttlに"-1"を設定してください。
- このAPIにて以下パラメータの値は変更できません
- SslV3
- TlsV10
- TlsV11
- TlsV12
- TlsV13
サンプル
リクエスト
PUT /r/(APIVersion)/(ServiceCode)/(UrlScheme)/cache_setting.json Host: cac.api.iij.jp Content-Type: application/json 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) { "QueryType": "all-cache", "CachedKey": "", "CacheTtl": [ { "Path": "example", "UseGlob": "off" "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": "html", "CacheType": "invalidate", "Ttl": "-1" } ], "CacheTtlBase": { "TextCookieCache": "off", "IgnoreClientNocache": "off", "RemoveQueryString": "off" }, "Cbc":"off" }
レスポンスボディ
{ |
"Result": { |
"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx", |
"ServiceCode": "cac########", |
"UrlScheme":"https", |
"QueryType":"all-cache", |
"CachedKey":"", |
"CacheTtl": |
[ |
{ |
"Path":"example", |
"UseGlob":"off", |
"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":"off" |
} |
} |