このページは、まだ日本語ではご利用いただけません。翻訳中です。
古いプラグインバージョンのドキュメントを閲覧しています。
構成
このプラグインはDBレスモードに対応しています。
パラメータ
このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。
-
name or plugin
string requiredプラグイン名。この場合は
request-transformer-advanced
。- 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_method
string matches:^%u+$
Changes the HTTP method for the upstream request.
-
remove
record required-
body
array of typestring
List of parameter names. Remove the parameter if and only if content-type is one of the following: [
application/json
,multipart/form-data
,application/x-www-form-urlencoded
]; and parameter is present.
-
headers
array of typestring
List of header names. Unset the headers with the given name.
-
querystring
array of typestring
List of querystring names. Remove the querystring if it is present.
-
-
rename
record required-
body
array of typestring
List of parameter
name:value
pairs. Rename the parameter name if and only if content-type is one of the following: [application/json
,multipart/form-data
,application/x-www-form-urlencoded
]; and parameter is present.
-
headers
array of typestring
List 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.
-
querystring
array of typestring
List 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.
-
-
replace
record required-
body
array of typestring
List 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.
-
headers
array of typestring
List 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.
-
querystring
array of typestring
List of queryname:value pairs. If and only if the querystring name is already set, replace its old value with the new one. Ignored if the header is not already set.
-
uri
stringUpdates the upstream request URI with given value. This value can only be used to update the path part of the URI; not the scheme, nor the hostname.
-
-
add
record required-
body
array of typestring
List 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 form-encoded body. Ignored if the parameter is already present.
-
headers
array of typestring
List 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.
-
querystring
array of typestring
List of
queryname:value
pairs. If and only if the querystring name is not already set, set a new querystring with the given value. Ignored if the querystring name is already set.
-
-
append
record required-
body
array of typestring
List 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, the two values (old and new) will be aggregated in an array.
-
headers
array of typestring
List of
headername:value
pairs. If the header is not set, set it with the given value. If it is already set, a new header with the same name and the new value will be set.
-
querystring
array of typestring
List 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.
-
-
allow
record required-
body
set of typestring
Set of parameter names. If and only if content-type is one the following: [
application/json
,multipart/form-data
,application/x-www-form-urlencoded
]; allow only allowed parameters in the body.
-
-