Request Callout Configuration - Plugin

name or plugin

string required

プラグイン名。この場合はrequest-callout 。

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

instance_name

string

プラグインのインスタンスを識別するための任意のカスタム名 (例: request-callout_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を使用する場合は必要ありません。

consumer_group.name or consumer_group.id

string

プラグインが対象とするコンシューマグループの名前または ID。設定されている場合、プラグインは指定されたグループが認証されているリクエストに対してのみアクティブになります/plugins エンドポイント. /consumer_groups/{consumerGroupName|Id}/pluginsを使用する場合は必要ありません。

enabled

boolean default: true

このプラグインが適用されるかどうか。

config

record required

callouts

array of type record required
A collection of callout objects, where each object represents an HTTPrequest made in the context of a proxy request.
- name
  
  string required
  
  A string identifier for a callout. A callout object is referenceablevia its name in the kong.ctx.shared.callouts.
- depends_on
  
  array of type string required
  
  An array of callout names the current callout depends on.This dependency determines the callout execution order.
- request
  
  record required
  The customizations for the callout request.
  
  url
  
  string required referenceable
  
  The URL that will be requested.
  
  method
  
  string required default: GET matches: ^%u+$
  
  The HTTP method that will be requested.
  
  http_opts
  
  record required
  
  HTTP connection parameters.
  
  ssl_verify
  
  boolean default: false
  
  If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
  
  ssl_server_name
  
  string
  
  The SNI used in the callout request. Defaults to host if omitted.
  
  timeouts
  
  record
  
  Socket timeouts in milliseconds. All or none must be set.
  
  connect
  
  integer between: 0 2147483646
  
  The socket connect timeout.
  
  write
  
  integer between: 0 2147483646
  
  The socket write timeout.
  
  read
  
  integer between: 0 2147483646
  
  The socket read timeout.
  
  proxy
  
  record
  
  Proxy settings.
  
  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_proxy
  
  string
  
  The HTTPS proxy URL. This proxy server will be used for HTTPS requests.
  
  http_proxy
  
  string
  
  The HTTP proxy URL. This proxy server will be used for HTTP requests.
  
  query
  
  record required
  
  Callout request query param customizations.
  
  forward
  
  boolean default: false
  
  If true, forwards the incoming request’s query params to the callout request.
  
  custom
  
  map
  
  The custom query params to be added in the callout HTTP request.Values can contain Lua expressions in the form $(some_lua_code).
  
  headers
  
  record required
  
  Callout request header customizations.
  
  forward
  
  boolean default: false
  
  If true, forwards the incoming request’s headers to the callout request.
  
  custom
  
  map
  
  The custom headers to be added in the callout HTTP request.Values can contain Lua expressions in the form $(some_lua_code).
  
  body
  
  record required
  
  Callout request body customizations.
  
  forward
  
  boolean default: false
  
  If true, forwards the incoming request’s body to the callout request.
  
  decode
  
  boolean default: false
  
  If true, decodes the request’s body to make it available for customizations.
  
  custom
  
  map
  
  The custom body fields to be added in the callout HTTP request.Values can contain Lua expressions in the form $(some_lua_code).
  
  error
  
  record required
  
  The error handling policy the plugin will apply to TCP and HTTP errors.
  
  on_error
  
  string default: fail Must be one of: retry, fail, continue
  
  retries
  
  integer default: 2
  
  The number of retries the plugin will attempt on TCP and HTTP errors if on_error is set to retry.
  
  http_statuses
  
  array of type integer
  
  The list of HTTP status codes considered errors under the error handling policy.
  
  error_response_code
  
  integer default: 400
  
  The error code to respond with if on_error is fail or if retries is achieved.
  
  error_response_msg
  
  string default: service callout error
  
  The error mesasge to respond with if on_error is fail or if retries is achieved.Templating with Lua expressions is supported.
  
  by_lua
  
  string
  
  Lua code that executes before the callout request is made.Standard Lua sandboxing restrictions apply.
- response
  
  record required
  Configurations of callout response handling.
  
  headers
  
  record required
  
  Callout response header customizations.
  
  store
  
  boolean default: true
  
  If false, skips storing the callout response headers intokong.ctx.shared.callouts..response.headers.
  
  body
  
  record required
  
  store
  
  boolean default: true
  
  If false, skips storing the callout response body into kong.ctx.shared.callouts..response.body.
  
  decode
  
  boolean default: false
  
  If true, decodes the response body before storing into the context. Only JSON is supported.
  
  by_lua
  
  string
  
  Lua code that executes after the callout request is made, before caching takes place. Standard Lua sandboxing restrictions apply.
- cache
  
  record required
  Callout caching configuration.
  
  bypass
  
  boolean default: false
  
  If true, skips caching the callout response.

cache

record required
Plugin global caching configuration.
- strategy
  
  string required default: off Must be one of: memory, redis, off
  
  The backing data store in which to hold cache entities. Accepted values are: off, memory, and redis.
- memory
  
  record required
  dictionary_name
  
  string required default: kong_db_cache
  
  The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template.
- redis
  
  record required
  host
  
  string default: 127.0.0.1
  
  A string representing a host name, such as example.com.
  
  port
  
  integer default: 6379 between: 0 65535
  
  An integer representing a port number between 0 and 65535, inclusive.
  
  connect_timeout
  
  integer default: 2000 between: 0 2147483646
  
  An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
  
  send_timeout
  
  integer default: 2000 between: 0 2147483646
  
  An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
  
  read_timeout
  
  integer default: 2000 between: 0 2147483646
  
  An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
  
  username
  
  string referenceable
  
  Username to use for Redis connections. If undefined, ACL authentication won’t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.
  
  password
  
  string referenceable encrypted
  
  Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
  
  sentinel_username
  
  string referenceable
  
  Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won’t be performed. This requires Redis v6.2.0+.
  
  sentinel_password
  
  string referenceable encrypted
  
  Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
  
  database
  
  integer default: 0
  
  Database to use for the Redis connection when using the redis strategy
  
  keepalive_pool_size
  
  integer default: 256 between: 1 2147483646
  
  The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn’t specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
  
  keepalive_backlog
  
  integer between: 0 2147483646
  
  Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.
  
  sentinel_master
  
  string
  
  Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
  
  sentinel_role
  
  string Must be one of: master, slave, any
  
  Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel.
  
  sentinel_nodes
  
  array of type record len_min: 1
  
  Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
  
  host
  
  string required default: 127.0.0.1
  
  A string representing a host name, such as example.com.
  
  port
  
  integer default: 6379 between: 0 65535
  
  An integer representing a port number between 0 and 65535, inclusive.
  
  cluster_nodes
  
  array of type record len_min: 1
  
  Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
  
  ip
  
  string required default: 127.0.0.1
  
  A string representing a host name, such as example.com.
  
  port
  
  integer default: 6379 between: 0 65535
  
  An integer representing a port number between 0 and 65535, inclusive.
  
  ssl
  
  boolean default: false
  
  If set to true, uses SSL to connect to Redis.
  
  ssl_verify
  
  boolean default: false
  
  If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
  
  server_name
  
  string
  
  A string representing an SNI (server name indication) value for TLS.
  
  cluster_max_redirections
  
  integer default: 5
  
  Maximum retry attempts for redirection.
  
  connection_is_proxied
  
  boolean default: false
  
  If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
- cache_ttl
  
  integer default: 300
  
  TTL in seconds of cache entities.

upstream

record required
Customizations to the upstream request.
- by_lua
  
  string
  
  Lua code that executes before the upstream request is made. Standard Lua sandboxing restrictions apply.
- query
  
  record required
  Upstream request query param customizations.
  
  forward
  
  boolean default: true
  
  If false, does not forward request query params to upstream request.
  
  custom
  
  map
  
  The custom query params to be added in the upstream HTTP request. Values can contain Lua expressions in the form $(some_lua_code).
- headers
  
  record required
  Callout request header customizations.
  
  forward
  
  boolean default: true
  
  If false, does not forward request headers to upstream request.
  
  custom
  
  map
  
  The custom headers to be added in the upstream HTTP request. Values can contain Lua expressions in the form $(some_lua_code).
- body
  
  record required
  Callout request body customizations.
  
  forward
  
  boolean default: true
  
  If false, skips forwarding the incoming request’s body to the upstream request.
  
  decode
  
  boolean default: true
  
  If true, decodes the request’s body to make it available for upstream by_lua customizations.
  
  custom
  
  map
  
  The custom body fields to be added in the upstream request body. Values can contain Lua expressions in the form $(some_lua_code).

構成

互換性のあるプロトコル

パラメータ

name or plugin

instance_name

service.name or service.id

route.name or route.id

consumer.name or consumer.id

consumer_group.name or consumer_group.id

enabled

config

callouts

name

depends_on

request

url

method

http_opts

ssl_verify

ssl_server_name

timeouts

connect

write

read

proxy

auth_username

auth_password

https_proxy

http_proxy

query

forward

custom

headers

forward

custom

body

forward

decode

custom

error

on_error

retries

http_statuses

error_response_code

error_response_msg

by_lua

response

headers

store

body

store

decode

by_lua

cache

bypass

cache

strategy

memory

dictionary_name

redis

host

port

connect_timeout

send_timeout

read_timeout

username

password

sentinel_username

sentinel_password

database

keepalive_pool_size

keepalive_backlog

sentinel_master

sentinel_role

sentinel_nodes

host

port

cluster_nodes

ip

port