Proxy Cache Configuration

このページは、まだ日本語ではご利用いただけません。翻訳中です。

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

構成

このプラグインは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を使用する場合は必要ありません。

• enabled

  boolean default: true

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

• config

  record required
  • response_code

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

    Upstream response status code considered cacheable.

  • request_method

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

    Downstream request methods considered cacheable.

  • content_type

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

    Upstream response content types considered cacheable. The plugin performs an exact match against each specified value.

  • cache_ttl

    integer default: 300

    TTL, in seconds, of cache entities.

  • strategy

    string required Must be one of: memory

    The backing data store in which to hold cache entities.

  • cache_control

    boolean required default: false

    When enabled, respect the Cache-Control behaviors defined in RFC7234.

  • ignore_uri_case

    boolean default: false

  • storage_ttl

    integer

    Number of seconds to keep resources in the storage backend. This value is independent of cache_ttl or resource TTLs defined by Cache-Control behaviors.

  • memory

    record required
    • dictionary_name

      string required default: kong_db_cache

      The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template.

  • vary_query_params

    array of type string

    Relevant query parameters considered for the cache key. If undefined, all params are taken into consideration.

  • vary_headers

    array of type string

    Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.