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

Forward Proxy Advanced Configuration

By Kong Inc.

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

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

構成

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

互換性のあるプロトコル

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

grpc, grpcs, http, https

パラメータ

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

  • name or plugin

    string required

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

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

  • instance_name

    string

    プラグインのインスタンスを識別するための任意のカスタム名 (例: forward-proxy_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

    • x_headers

      string required default: append Must be one of: append, transparent, delete

    • http_proxy_host

      string

      The HTTP hostname or IP address of the forward proxy to which to connect. Required if http_proxy_port is set.

      At least one of http_proxy_host or https_proxy_host must be specified.

      If http_proxy_host isn’t set, the plugin falls back to the value configured in https_proxy_host.

    • http_proxy_port

      integer between: 0 65535

      The TCP port of the HTTP forward proxy to which to connect. Required if http_proxy_host is set.

      At least one of http_proxy_port or https_proxy_port must be specified.

      If http_proxy_port isn’t set, the plugin falls back to the value configured in https_proxy_port.

    • https_proxy_host

      string

      The HTTPS hostname or IP address of the forward proxy to which to connect. Required if https_proxy_port is set.

      At least one of http_proxy_host or https_proxy_host must be specified.

      If https_proxy_host isn’t set, the plugin falls back to the value configured in http_proxy_host.

    • https_proxy_port

      integer between: 0 65535

      The TCP port of the HTTPS forward proxy to which to connect. Required if https_proxy_host is set.

      At least one of http_proxy_port or https_proxy_port must be specified.

      If https_proxy_port isn’t set, the plugin falls back to the value configured in http_proxy_port.

    • proxy_scheme

      string required default: http Must be one of: http

      The proxy scheme to use when connecting. Only http is supported.

    • auth_username

      string referenceable

      The username to authenticate with, if the forward proxy is protected by basic authentication.

    • auth_password

      string referenceable

      The password to authenticate with, if the forward proxy is protected by basic authentication.

    • https_verify

      boolean required default: false

      Whether the server certificate will be verified according to the CA certificates specified in lua_ssl_trusted_certificate.

  • proxy_host

    string
    Deprecation notice: This field has been deprecated and will be removed in a future version..

  • proxy_port

    integer
    Deprecation notice: This field has been deprecated and will be removed in a future version..