GET cache_setting

API情報

HTTPメソッドAPI名目的
GETcache_settingキャッシュ設定情報取得
  • キャッシュの設定情報を取得します。

個別パラメータ

URL
フィールドタイプ意味
UrlSchemeString

URLスキーム

値: http, https

 
HTTPリクエストボディ
  • なし

レスポンス

フィールドタイプ意味
Result.UrlSchemeString

URLスキーム

値: http, https

Result.QueryTypeString

クエリストリング付きアクセスの取り扱い設定 (no-cache: クエリストリング付アクセスをキャッシュしない, all-cache: クエリストリング付アクセスをすべてキャッシュする, key-cache: キャッシュするクエリパラメータ名を指定する)

値: no-cache, all-cache, key-cache

Result.CachedKeyString

キャッシュ対象のクエリストリングパラメタ文字列 

  • Result.QueryTypeが"key-cache"の場合のみ設定されています。
Result.CacheTtlArray

キャッシュルール設定

  • 最大100個
Result.CacheTtl.PathString

URLパス

  • 最大256文字
Result.CacheTtl.SubDirectoryString

前方一致するすべてのファイルをキャッシュする場合は配下(on)、URLと完全一致するファイルのみをキャッシュする場合は直下(off)

値: on, off

  • Result.CacheTtl.CacheTypeが"invalidate"の場合は"on"が設定されています。
Result.CacheTtl.ExtensionString

キャッシュするファイルの拡張子

  • 最大5文字
  • Result.CacheTtl.CacheTypeが"invalidate"の場合は無視されています。
Result.CacheTtl.CacheTypeString

コンテンツのキャッシュ方法 (validate: キャッシュする, ignore-server-nocache:no-cacheレスポンスヘッダを無視してキャッシュする, invalidate: キャッシュしない)

値: validate, ignore-server-nocache, invalidate

Result.CacheTtl.TtlString

キャッシュ更新までの時間(キャッシュTTL)

  • 1~43200
  • Result.CacheTtl.CacheTypeが"invalidate"の場合は"-1"が設定されています。
Result.CacheTtl.TextCookieCacheString

リクエストにCookieが含まれている場合にContent-Typeがテキストのコンテンツをキャッシュする場合は "on", キャッシュしない場合は "off"
値: on, off

  • Content-Typeがテキスト以外の場合は、本設定によらずキャッシュします。
  • 2014/10/21 以前にご契約のお客様は,常に"off"になります。
Result.CacheTtl.IgnoreClientNocacheString

no-cache付きリクエストをキャッシュする場合は"on",キャッシュしない場合は"off"
値: on, off

  • 2014/10/21 以前にご契約のお客様は,常に"off"になります。
Result.CacheTtlBase.TextCookieCacheString

"on" の場合,Result.CacheTtl.TextCookieCache の設定に関わらず, 全てのURLに「リクエストにCookieが含まれている場合にContent-Typeがテキストのコンテンツをキャッシュする」 が適用されます。
値: on, off

  • Content-Typeがテキスト以外の場合は、本設定によらずキャッシュします。
  • 2014/10/21 以前にご契約のお客様は,常に"off"になります。
Result.CacheTtlBase.IgnoreClientNocacheString

"on" にした場合,Result.CacheTtl.IgnoreClientNocache の設定に関わらず,全てのURLに 「no-cache付きリクエストをキャッシュする」 が適用されます。
値: on, off

  • 2014/10/21 以前にご契約のお客様は,常に"off"になります。
Result.HttpsCacheString

HTTPSコンテンツのキャッシュ方法

  • Result.UrlSchemeが"https"の場合に設定されています。
  • 2016/7/26 以降、本設定は無効になり、レスポンス値は常に"off"となります。
  • HTTPSコンテンツのキャッシュ方法を確認する場合はキャッシュバイパス機能の設定をご参照ください。
  • キャッシュバイパス機能につきましては詳細資料をご参照ください。
Result.SslV3String 

HTTPS通信でSSL 3.0 を有効にする場合は"on" , 無効にする場合は"off"
値: on , off

  • Result.UrlSchemeが"https"の場合に設定されています。
  • 2015/11/10 以降、SSL 3.0 設定は標準で無効になります。

エラーコード

  • このAPIに関する個別エラーはありません。
  • 共通エラーコードはエラーレスポンスを参照してください。

制限

  • なし

サンプル 

リクエスト

GET /r/(APIVersion)/(ServiceCode)/(UrlScheme)/cache_setting.json
Host: cac.api.iij.jp
Date: Mon, 20 Jan 2014 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": "http",
        "QueryType": "all-cache",
        "CachedKey": "",
        "CacheTtl": [
            {
                "Path": "example",
                "SubDirectory": "off",
                "Extension": "",
                "CacheType": "validate",
                "Ttl": "300",
                "TextCookieCache": "on",
                "IgnoreClientNocache": "on"
            },
            {
                "Path": "example/js",
                "SubDirectory": "on",
                "Extension": "js",
                "CacheType": "validate",
                "Ttl":"1440",
                "TextCookieCache": "on",
                "IgnoreClientNocache": "on"
            },
            {
                "Path":"example",
                "SubDirectory":"on",
                "Extension":"html",
                "CacheType":"invalidate",
                "Ttl":"-1",
                "TextCookieCache": "on",
                "IgnoreClientNocache": "on"
            }
        ],
        "CacheTtlBase": {
            "TextCookieCache": "off",
            "IgnoreClientNocache": "off"
        }
    }
}