ヘッダー変更ポリシーは、リクエストがバックエンドサービスに転送される前、または応答がクライアントに返される前に、ヘッダーを変更します。Cloud-native API Gateway のルートに対して、ヘッダーの追加、更新、削除が可能です。
操作手順
-
Cloud-native API Gateway では、ヘッダー変更ポリシーを構成する方法が 2 つあります。
インスタンス外の API
-
API Gateway コンソールにログインします。左側のナビゲーションウィンドウで API を選択し、上部のナビゲーションバーでリージョンを選択します。
-
対象の API をクリックします。ドロップダウンリストからポリシーを構成するインスタンスを選択するか、すべてのインスタンス を選択します。
-
Routes タブで、対象のルートを選択します。
インスタンス内の API
-
API Gateway コンソールにログインします。 左側のナビゲーションウィンドウで、インスタンスを選択します。 上部のナビゲーションバーで、リージョンを選択します。
-
[インスタンス]ページで、対象のゲートウェイインスタンスの ID をクリックします。左側のナビゲーションウィンドウで[API]を選択し、対象の API をクリックします。
-
Routes タブで、対象のルートを選択します。
-
-
Configure Policy タブをクリックし、Inbound Processing または Outbound Processing の下にある ポリシー / プラグインを有効化 をクリックします。
-
Edit Header カードをクリックします。ポリシーの追加: ヘッダー編集 パネルでパラメーターを設定し、Add をクリックします。
パラメーター
説明
Enable
-
有効:リクエストおよび応答にヘッダー変更ポリシーを適用します。
-
無効:ヘッダー変更ポリシーを適用しません。
Header Type
変更するヘッダーのタイプです。有効な値は、Request および Response です。
-
Request:ポリシーはリクエストヘッダーに適用されます。
-
Response:ポリシーはレスポンスヘッダーに適用されます。
Operation Type
ヘッダーに対して実行する操作です。有効な値は、Add、Modify、および Delete です。
-
Add:リクエストまたは応答にヘッダーを追加します。
説明指定されたヘッダーがすでに存在する場合、この操作により新しいヘッダー値が既存の値にカンマ (,) で区切られて追記されます。
-
Modify:リクエストまたは応答内の指定されたヘッダーを変更します。
説明-
指定されたヘッダーが存在しない場合、この操作により指定されたキーと値を持つ新しいヘッダーが追加されます。
-
指定されたヘッダーが存在する場合、この操作によりその値が上書きされます。
-
-
Delete:リクエストまたは応答から指定されたヘッダーを削除します。
ヘッダーキー
追加、変更、または削除するヘッダーの名前です。
ヘッダー値
ヘッダーの値です。
-
結果の確認
以下の例では、テスト用のレスポンスヘッダー test:demo を追加しています。ご利用のビジネスシナリオに合わせて、値を置き換えてください。
次のコマンドを実行して、構成をテストします。
curl -I http://121.196.XX.XX/demo/item/list // ご利用のゲートウェイの Ingress 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