このページは、まだ日本語ではご利用いただけません。翻訳中です。
古いプラグインバージョンのドキュメントを閲覧しています。
構成
このプラグインはDB-lessモードと部分的に互換性があります。
The functions will be executed, but if the configured functions attempt to write to the database, the writes will fail.
互換性のあるプロトコル
Kong Functions (Pre-Plugins)プラグインは以下のプロトコルに対応しています:
grpc
, grpcs
, http
, https
, ws
, wss
パラメータ
このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。
-
name or plugin
string requiredプラグイン名。この場合は
pre-function
。- 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
を使用する場合は必要ありません。 -
enabled
boolean default:true
このプラグインが適用されるかどうか。
-
config
record required-
certificate
array of typestring
requiredArray of stringified Lua code to be cached and run in sequence during the certificate phase.
Note: This only runs on global plugins.
-
rewrite
array of typestring
requiredArray of stringified Lua code to be cached and run in sequence during the rewrite phase.
Note: This only runs on global plugins.
-
access
array of typestring
requiredArray of stringified Lua code to be cached and run in sequence during the access phase.
-
header_filter
array of typestring
requiredArray of stringified Lua code to be cached and run in sequence during the header_filter phase.
-
body_filter
array of typestring
requiredArray of stringified Lua code to be cached and run in sequence during the body_filter phase.
-
log
array of typestring
requiredArray of stringified Lua code to be cached and run in sequence during the log phase.
-
ws_handshake
array of typestring
required
-
ws_client_frame
array of typestring
required
-
ws_upstream_frame
array of typestring
required
-
ws_close
array of typestring
required
-