WebSocket Validator設定

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

構成

このプラグインはDBレスモードに対応しています。

互換性のあるプロトコル

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

ws, wss

パラメータ

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

• name or plugin

  string required

  プラグイン名。この場合は websocket-validator 。

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

• instance_name

  string

  プラグインのインスタンスを識別するための任意のカスタム名 (例: websocket-validator_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
  • client

    record
    • text

      record
      • type

        string required Must be one of: draft4

        The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported.

      • schema

        string required

        Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type.

    • binary

      record
      • type

        string required Must be one of: draft4

        The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported.

      • schema

        string required

        Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type.

  • upstream

    record
    • text

      record
      • type

        string required Must be one of: draft4

        The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported.

      • schema

        string required

        Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type.

    • binary

      record
      • type

        string required Must be one of: draft4

        The corresponding validation library for config.upstream.binary.schema. Currently, only draft4 is supported.

      • schema

        string required

        Schema used to validate upstream-originated binary frames. The semantics of this field depend on the validation type set by config.upstream.binary.type.