このページは、まだ日本語ではご利用いただけません。翻訳中です。
古いプラグインバージョンのドキュメントを閲覧しています。
構成
このプラグインはDBレスモードに対応しています。
パラメータ
このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。
-
string required
プラグイン名。この場合は
request-transformer
。- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
name
です。 - Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドは
plugin
です。
- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
-
string
プラグインが対象とするサービス名または ID。最上位の
/plugins
エンドポイント. からプラグインをサービスに追加する場合は、これらのパラメータのいずれかを設定してください/services/{serviceName|Id}/plugins
を使用する場合は必要ありません。 -
string
プラグインがターゲットとするルート名または ID。最上位の
/plugins
エンドポイント. を通るルートにプラグインを追加する場合は、これらのパラメータのいずれかを設定してください/routes/{routeName|Id}/plugins
を使用する場合は必要ありません。 -
string
プラグインがターゲットとするコンシューマーの名前または ID。 最上位の
/plugins
エンドポイント. からコンシューマーにプラグインを追加する場合は、これらのパラメーターのいずれかを設定してください/consumers/{consumerName|Id}/plugins
を使用する場合は必要ありません。 -
boolean default:
true
このプラグインが適用されるかどうか。
-
record required
-
string matches:
^%u+$
Sets the HTTP method for the upstream request.
-
record required
-
array of type
string
requiredList of parameter names. Remove the parameter if and only if content-type is one the following: [
application/json
,multipart/form-data
,application/x-www-form-urlencoded
] and the parameter is present.
-
array of type
string
requiredList of header names. Unset the headers with the given name.
-
array of type
string
requiredList of querystring names. Remove the querystring if it is present.
-
-
record required
-
array of type
string
requiredList of
paramname:value
pairs. Rename the parameter name if and only if content-type is one the following [application/json
,multipart/form-data
,application/x-www-form-urlencoded
] and the parameter is present.
-
array of type
string
requiredList of
headername:value
pairs. If and only if the header is already set, rename the header. The value is unchanged. Ignored if the header is not already set.
-
array of type
string
requiredList of queryname:value pairs. If and only if the field name is already set, rename the field name. The value is unchanged. Ignored if the field name is not already set.
-
-
record required
-
array of type
string
requiredList of
paramname:value
pairs. If and only if content-type is one the following [application/json
,multipart/form-data
,application/x-www-form-urlencoded
] and the parameter is already present, replace its old value with the new one. Ignored if the parameter is not already present.
-
array of type
string
requiredList of
headername:value
pairs. If and only if the header is already set, replace its old value with the new one. Ignored if the header is not already set.
-
array of type
string
requiredList of
queryname:value pairs
. If and only if the field name is already set, replace its old value with the new one. Ignored if the field name is not already set.
-
string
Updates the upstream request URI with a given value. This value can be used to update only the path part of the URI, not the scheme or the hostname.
-
-
record required
-
array of type
string
requiredList of
paramname:value
pairs. If and only if content-type is one the following [application/json
,multipart/form-data
,application/x-www-form-urlencoded
] and the parameter is not present, add a new parameter with the given value to the form-encoded body. Ignored if the parameter is already present.
-
array of type
string
requiredList of
headername:value
pairs. If and only if the header is not already set, set a new header with the given value. Ignored if the header is already set.
-
array of type
string
requiredList of
queryname:value
pairs. If and only if the querystring is not already set, set a new querystring with the given value. Ignored if the querystring is already set.
-
-
record required
-
array of type
string
requiredList of
paramname:value
pairs. If the content-type is one the following [application/json
,application/x-www-form-urlencoded
], add a new parameter with the given value if the parameter is not present. Otherwise, if it is already present, aggregate the two values (old and new) in an array.
-
array of type
string
requiredList of
headername:value
pairs. If the header is not set, set it with the given value. If it is already set, an additional new header with the same name and the new value will be appended.
-
array of type
string
requiredList of
queryname:value
pairs. If the querystring is not set, set it with the given value. If it is already set, a new querystring with the same name and the new value will be set.
-
-