jq Configuration

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

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

構成

互換性のあるプロトコル

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

grpc, grpcs, http, https

パラメータ

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

• name or plugin

  string required

  プラグイン名。この場合は jq 。

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

• 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
  • request_jq_program

    string

    The jq program to run on the request body. For example, .[0] | { "X-Foo": .foo }. Either request_jq_program or response_jq_plugin must be included in the configuration.

  • request_jq_program_options

    record

    Boolean option flags to modify the run behavior of the jq program run on the request body.

    • compact_output: Returns output in a compact form without additional spacing, and with each JSON object on a single line. Defaults to true. Set to false for ‘pretty’ output.
    • raw_output: Outputs as raw strings, not JSON quoted. Default is false.
    • join_output: Similar to raw_output but does not output newline separators. Default is false.
    • ascii_output: jq usually outputs non-ASCII Unicode codepoints as UTF-8, even if the input specified them as escape sequences (like μ). Using this option, you can force jq to produce pure ASCII output, replacing every non-ASCII character with the equivalent escape sequence. Default is false.
    • sort_keys: Outputs the fields of each object with the keys in sorted order. Default is false.

    • compact_output

      boolean required default: true

    • raw_output

      boolean required default: false

    • join_output

      boolean required default: false

    • ascii_output

      boolean required default: false

    • sort_keys

      boolean required default: false

  • request_if_media_type

    array of type string default: application/json

    A list of media type strings. The media type included in the Content-Type request header must match one of the media types on this list for the program to run.

  • response_jq_program

    string

    The jq program to run on the response body. For example, .[0] | { "X-Foo": .foo }. Either request_jq_program or response_jq_plugin must be included in configuration.

  • response_jq_program_options

    record

    Boolean option flags to modify the run behavior of the jq program run on the response body.

    • compact_output: Returns output in a compact form without additional spacing, and with each JSON object on a single line. Defaults to true. Set to false for ‘pretty’ output.
    • raw_output: Outputs as raw strings, not JSON quoted. Default is false.
    • join_output: Similar to raw_output but does not output newline separators. Default is false.
    • ascii_output: jq usually outputs non-ASCII Unicode codepoints as UTF-8, even if the input specified them as escape sequences (like μ). Using this option, you can force jq to produce pure ASCII output, replacing every non-ASCII character with the equivalent escape sequence. Default is false.
    • sort_keys: Outputs the fields of each object with the keys in sorted order. Default is false.

    • compact_output

      boolean required default: true

    • raw_output

      boolean required default: false

    • join_output

      boolean required default: false

    • ascii_output

      boolean required default: false

    • sort_keys

      boolean required default: false

  • response_if_media_type

    array of type string default: application/json

    A list of media type strings. The media type included in the Content-Type response header must match one of the media types on this list for the program to run.

  • response_if_status_code

    array of type integer default: 200

    A list of HTTP response status codes. The response status code must match one of the response status codes on this list for the program to run.