ヘッダー設定ポリシーを設定して、リクエストが宛先のバックエンドサービスに転送される前、またはバックエンドサービスの応答がクライアントに返される前に、リクエストまたは応答のヘッダーを変更できます。このトピックでは、クラウドネイティブゲートウェイのヘッダー設定ポリシーを設定する方法について説明します。
ヘッダーポリシーの設定
クラウドネイティブ API Gateway は、2 つのアプローチでヘッダー変更ポリシーの設定をサポートします。
インスタンス外の API
API Gateway コンソールにログインします。左側のナビゲーションウィンドウで、 をクリックします。上部のナビゲーションバーで、リージョンを選択します。
ターゲット API をクリックします。API 詳細ページで、ドロップダウンリストからインスタンスを選択するか、[すべてのインスタンス] を選択します。
[ルーティング] リストからターゲットルートを選択します。
インスタンス内 API
クラウドネイティブ API Gateway コンソールにログインします。左側のナビゲーションウィンドウで [インスタンス] を選択し、上部のメニューバーでリージョンを選択します。
[インスタンス] ページで、ターゲットゲートウェイインスタンス ID をクリックします。左側のナビゲーションウィンドウで [API] を選択し、ターゲット API をクリックします。
[ルートリスト] からターゲットルートを選択します。
API Gateway コンソールにログインします。
左側のナビゲーションウィンドウで、 をクリックします。上部のナビゲーションバーで、リージョンを選択します。
ターゲット API をクリックします。API 詳細ページで、ターゲットルートの名前をクリックします。[ポリシー設定] タブをクリックし、左側の [ヘッダー編集] をクリックします。
右側の
または [ルールの追加] をクリックします。表示されるリストでルールパラメーターを設定し、[保存] をクリックします。次の表にパラメーターを示します。パラメーター
説明
ヘッダータイプ
ヘッダータイプ。有効な値:
[リクエスト]: ヘッダー設定ポリシーはリクエストに対して有効になります。
[応答]: ヘッダー設定ポリシーは応答に対して有効になります。
操作タイプ
リクエストまたは応答に対して実行できるヘッダー関連の操作。有効な値:
[追加]: リクエストまたは応答にヘッダーを追加します。
説明指定されたヘッダーがリクエストまたは応答にすでに存在する場合、このポリシーで指定されたヘッダー値は既存のヘッダー値に連結されます。値はコンマ (,) で区切られます。
[変更]: リクエストまたは応答のヘッダーを変更します。
説明指定されたヘッダーがリクエストまたは応答に存在しない場合、このルールで指定されたヘッダーキーと値に基づいてヘッダーがリクエストまたは応答に追加されます。
指定されたヘッダーがすでに存在する場合、その値はこのルールで指定されたヘッダー値で上書きされます。
[削除]: リクエストまたは応答からヘッダーを削除します。
ヘッダーキー
リクエストまたは応答のヘッダーの名前。
ヘッダー値
リクエストまたは応答のヘッダーの値。
ヘッダー設定ポリシーが設定されたら、[有効] をオンにします。
ヘッダー設定ポリシーを有効にすると、ゲートウェイはリクエストまたは応答のヘッダーを制御します。
ヘッダー設定ポリシーを無効にすると、ゲートウェイはリクエストまたは応答のヘッダーを制御しません。
結果の確認
この例では、ヘッダーが応答に追加されます。次の図は、ポリシーの構成を示しています。
次のコマンドを実行して、テストリクエストを送信します。
curl -I http://121.196.XX.XX/demo/item/list // ゲートウェイのイングレス IP アドレス。次の応答が返されます。応答には test:demo ヘッダーが含まれています。
HTTP/1.1 200 OK
x-content-type-options: nosniff
x-xss-protection: 1; mode=block
cache-control: no-cache, no-store, max-age=0, must-revalidate
pragma: no-cache
expires: 0
x-frame-options: DENY
content-type: application/json
content-length: 86
date: Tue, 30 Nov 2021 03:03:04 GMT
x-envoy-upstream-service-time: 4
test: demo
server: istio-envoy