Rate Limiting設定

このページは、まだ日本語ではご利用いただけません。翻訳中です。

古いプラグインバージョンのドキュメントを閲覧しています。

構成

このプラグインはDB-lessモードと部分的に互換性があります。

The plugin will run fine with the local policy (which doesn’t use the database) or the redis policy (which uses an independent Redis, so it is compatible with DB-less).

The plugin will not work with the cluster policy, which requires writes to the database.

互換性のあるプロトコル

Rate Limitingプラグインは以下のプロトコルに対応しています：

grpc, grpcs, http, https

パラメータ

このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。

• name or plugin

  string required

  プラグイン名。この場合は rate-limiting 。

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

• instance_name

  string

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

• enabled

  boolean default: true

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

• config

  record required
  • second

    number

    The number of HTTP requests that can be made per second.

  • minute

    number

    The number of HTTP requests that can be made per minute.

  • hour

    number

    The number of HTTP requests that can be made per hour.

  • day

    number

    The number of HTTP requests that can be made per day.

  • month

    number

    The number of HTTP requests that can be made per month.

  • year

    number

    The number of HTTP requests that can be made per year.

  • limit_by

    string default: consumer Must be one of: consumer, credential, ip, service, header, path

    The entity that is used when aggregating the limits.

  • header_name

    string

    A string representing an HTTP header name.

  • path

    string starts_with: /

    A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).

  • policy

    string default: local len_min: 0 Must be one of: local, cluster, redis

    The rate-limiting policies to use for retrieving and incrementing the limits.

  • fault_tolerant

    boolean required default: true

    A boolean value that determines if the requests should be proxied even if Kong has troubles connecting a third-party data store. If true, requests will be proxied anyway, effectively disabling the rate-limiting function until the data store is working again. If false, then the clients will see 500 errors.

  • redis_host

    string

    A string representing a host name, such as example.com.

  • redis_port

    integer default: 6379 between: 0 65535

    An integer representing a port number between 0 and 65535, inclusive.

  • redis_password

    string referenceable len_min: 0

    When using the redis policy, this property specifies the password to connect to the Redis server.

  • redis_username

    string referenceable

    When using the redis policy, this property specifies the username to connect to the Redis server when ACL authentication is desired.

  • redis_ssl

    boolean required default: false

    When using the redis policy, this property specifies if SSL is used to connect to the Redis server.

  • redis_ssl_verify

    boolean required default: false

    When using the redis policy with redis_ssl set to true, this property specifies it server SSL certificate is validated. Note that you need to configure the lua_ssl_trusted_certificate to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.

  • redis_server_name

    string

    A string representing an SNI (server name indication) value for TLS.

  • redis_timeout

    number default: 2000

    When using the redis policy, this property specifies the timeout in milliseconds of any command submitted to the Redis server.

  • redis_database

    integer default: 0

    When using the redis policy, this property specifies the Redis database to use.

  • hide_client_headers

    boolean required default: false

    Optionally hide informative response headers.

  • error_code

    number default: 429

    Set a custom error code to return when the rate limit is exceeded.

  • error_message

    string default: API rate limit exceeded

    Set a custom error message to return when the rate limit is exceeded.

  • sync_rate

    number required default: -1

    How often to sync counter data to the central data store. A value of -1 results in synchronous behavior.