コンテンツにスキップ
|
Plugin Hub
report-issue問題を報告する
header icon

Proxy Cache設定

By Kong Inc.
古いプラグインバージョンのドキュメントを閲覧しています。

構成

このプラグインはDBレスモードに対応しています。

互換性のあるプロトコル

Proxy Cacheプラグインは以下のプロトコルに対応しています：

grpc, grpcs, http, https, tcp, tls, tls_passthrough, udp, ws, wss

パラメータ

このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。

  • name or plugin

    string required

    プラグイン名。この場合は proxy-cache 。

    • Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドはnameです。
    • Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドはpluginです。

  • instance_name

    string

    プラグインのインスタンスを識別するための任意のカスタム名 (例: proxy-cache_my-service 。

    インスタンス名はKong ManagerとKonnectに表示されるので、 例えば複数のサービスで同じプラグインを複数のコンテキストで実行する場合に便利です。また、Kong Admin API経由で特定のプラグインインスタンスに アクセスするためにも使用できます。

    インスタンス名は、次のコンテキスト内で一意である必要があります。

    • Kong Gateway Enterpriseのワークスペース内
    • Konnectのコントロールプレーン（CP）またはコントロールプレーン（CP）グループ内
    • Kong Gateway (OSS)の全世界

  • service.name or service.id

    string

    プラグインが対象とするサービス名または ID。最上位の /plugins エンドポイント. からプラグインをサービスに追加する場合は、これらのパラメータのいずれかを設定してください /services/{serviceName|Id}/plugins を使用する場合は必要ありません。

  • route.name or route.id

    string

    プラグインがターゲットとするルート名または ID。最上位の /plugins エンドポイント. を通るルートにプラグインを追加する場合は、これらのパラメータのいずれかを設定してください /routes/{routeName|Id}/plugins を使用する場合は必要ありません。

  • consumer.name or consumer.id

    string

    プラグインがターゲットとするコンシューマーの名前または ID。 最上位の /plugins エンドポイント. からコンシューマーにプラグインを追加する場合は、これらのパラメーターのいずれかを設定してください /consumers/{consumerName|Id}/pluginsを使用する場合は必要ありません。

  • consumer_group.name or consumer_group.id

    string

    プラグインが対象とするコンシューマグループの名前または ID。 設定されている場合、プラグインは指定されたグループが認証されているリクエストに対してのみアクティブになります/plugins エンドポイント. /consumer_groups/{consumerGroupName|Id}/pluginsを使用する場合は必要ありません。

  • enabled

    boolean default: true

    このプラグインが適用されるかどうか。

  • config

    record required

    • response_code

      array of type integer required default: 200, 301, 404 len_min: 1

      キャッシュ可能とみなされるアップストリーム応答コンテンツステータスコード。

    • request_method

      array of type string required default: GET, HEAD Must be one of: HEAD, GET, POST, PATCH, PUT

      キャッシュ可能とみなされるダウンストリームリクエストメソッド。

    • content_type

      array of type string required default: text/plain, application/json

      キャッシュ可能とみなされるアップストリーム応答コンテンツ タイプ。 プラグインは指定された各値に対して完全一致を実行します。

    • cache_ttl

      integer default: 300

      キャッシュエンティティのTTL（秒単位）。

    • strategy

      string required Must be one of: memory

      キャッシュエンティティを保持するバッキングデータストア。

    • cache_control

      boolean required default: false

      有効にすると、RFC7234で定義されているCache-Controlの動作が尊重されます。

    • ignore_uri_case

      boolean default: false

    • storage_ttl

      integer

      ストレージバックエンドにリソースを保持する秒数。この値は、Cache-Control動作によって定義されるcache_ttlまたはリソースTTLとは無関係です。

    • memory

      record required

      • dictionary_name

        string required default: kong_db_cache

        メモリストラテジが選択されたときにキャッシュエンティティを保持する共有ディクショナリの名前。このディクショナリは現在、Kong Nginxテンプレートで手動で定義する必要があることに注意してください。

    • vary_query_params

      array of type string

      キャッシュキーに考慮される関連のクエリパラメータ。未定義の場合、すべてのパラメータが考慮されます。

    • vary_headers

      array of type string

      キャッシュキーに考慮される関連ヘッダー。未定義の場合、どのヘッダーも考慮されません。

    • response_headers

      record required

      キャッシュされた応答に含めるべきキャッシュ関連の診断ヘッダー

      • age

        boolean default: true

      • X-Cache-Status

        boolean default: true

      • X-Cache-Key

        boolean default: true