このページは、まだ日本語ではご利用いただけません。翻訳中です。
古いプラグインバージョンのドキュメントを閲覧しています。
構成
このプラグインはDBレスモードに対応しています。
パラメータ
このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。
-
name or plugin
string requiredプラグイン名。この場合は
forward-proxy
。- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
name
です。 - Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドは
plugin
です。
- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
-
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-
http_proxy_host
stringThe 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
orhttps_proxy_host
must be specified.If
http_proxy_host
isn’t set, the plugin falls back to the value configured inhttps_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
orhttps_proxy_port
must be specified.If
http_proxy_port
isn’t set, the plugin falls back to the value configured inhttps_proxy_port
.
-
https_proxy_host
stringThe 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
orhttps_proxy_host
must be specified.If
https_proxy_host
isn’t set, the plugin falls back to the value configured inhttp_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
orhttps_proxy_port
must be specified.If
https_proxy_port
isn’t set, the plugin falls back to the value configured inhttp_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 referenceableThe username to authenticate with, if the forward proxy is protected by basic authentication.
-
auth_password
string referenceableThe 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
stringDeprecation notice:
-
proxy_port
integerDeprecation notice: