CORS設定

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

構成

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

互換性のあるプロトコル

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

grpc, grpcs, http, https

パラメータ

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

• name or plugin

  string required

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

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

• instance_name

  string

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

• enabled

  boolean default: true

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

• config

  record required
  • origins

    array of type string

    Access-Control-Allow-Originヘッダーで許可されるドメインのリスト。すべてのオリジンを許可したい場合は、この設定フィールドに*を単一の値として追加してください。受け入れられる値は、flat文字列またはPCRE正規表現のいずれかです。

  • headers

    array of type string

    Access-Control-Allow-Headersヘッダーの値。

  • exposed_headers

    array of type string

    Access-Control-Expose-Headersヘッダーの値。指定しない場合、カスタムヘッダーは公開されません。

  • methods

    array of type string default: GET, HEAD, PUT, PATCH, POST, DELETE, OPTIONS, TRACE, CONNECT Must be one of: GET, HEAD, PUT, PATCH, POST, DELETE, OPTIONS, TRACE, CONNECT

    ‘Access-Control-Allow-Methodsヘッダーの値。使用可能なオプションには、GET、HEAD、PUT、PATCH、POST、DELETE、OPTIONS、TRACE、CONNECT などがあります。デフォルトでは、すべてのオプションが許可されています。

  • max_age

    number

    プリフライトリクエストの結果をキャッシュできる期間をseconds（秒）単位で示します。

  • credentials

    boolean required default: false

    Access-Control-Allow-Credentialsヘッダーを値としてtrueで送信するかどうかを決定するフラグ。

  • private_network

    boolean required default: false

    Access-Control-Allow-Private-Networkヘッダーを値としてtrueで送信するかどうかを決定するフラグ。

  • preflight_continue

    boolean required default: false

    プラグインにOPTIONSプリフライトリクエストをアップストリームサービスにプロキシするように指示するブール値。