プロキシー

プロキシー ・ポリシーを適用して、アセンブリー内の別の API を呼び出します (特に、別の API に大きなペイロードが含まれている場合)。 バックエンドからの応答は message.body および応答オブジェクト変数 (定義されている場合) に保存されます。 1 つのアセンブリー・フローで実行できるポリシーは 1 つだけです。

ゲートウェイのサポート

表 1. このポリシーをサポートするゲートウェイと、対応するポリシーのバージョンを示す表
ゲートウェイ ポリシーのバージョン
DataPower® Gateway (v5 compatible) 1.0.0
DataPower API Gateway、 Invoke で提供される機能  

このトピックでは、アセンブリー・ユーザー・インターフェースでのポリシーの構成方法について説明します。 OpenAPI ソースでのポリシーの構成方法について詳しくは、 プロキシーを参照してください。

概要

アセンブリーの固有のフローごとに実行できる プロキシー ・ポリシーは 1 つのみです。 複数の プロキシー ・ポリシーがアセンブリーの相互排他的なブランチに含まれている場合は、それらのポリシーを適用できます。

Proxy ポリシーを使用して、マルチパート・フォーム・データを返すことができます。つまり、応答が以下のように設定されている場合です。Content-Type: multipart/relatedただし、 プロキシー はアセンブリー内の最後のポリシーでなければなりません。そうでない場合は、後続のステップで受信した応答を操作できるため、マルチパート・フォーム・データが失われます。

proxy ポリシーは、条件付きポリシー内にある場合、API で実行される 最終 ポリシーでなければなりません。 後でさらに処理が必要な場合は、 proxy ポリシーではなく invoke ポリシーを使用します。

プロパティー

以下の表に、このポリシーのプロパティーをリストします。表には、プロパティーが必須かどうか、入力用の有効な値とデフォルト値、および値のデータ型が示されています。

表 2. プロキシー ・ポリシーのプロパティー
プロパティー・ラベル 必須 説明 データ・タイプ
タイトル はい ポリシーのタイトル。

デフォルト値は proxyです。

 ストリング
説明 いいえ ポリシーの説明。 ストリング
呼び出し URL はい ターゲット・サービスの URL を指定します。

SOAP API の場合、URL がデフォルトで追加されます。 可能であれば、インポートされた WSDL で定義されている情報から、「プロキシー URL」の値はあらかじめ入力されます。

 ストリング
TLS プロファイル いいえ データ伝送をセキュアにするために使用する TLS プロファイルを指定します。 ストリング
Timeout はい エンドポイントからの応答を待機する時間 (秒)。

デフォルト値は 60です。

 整数
ユーザー名 いいえ HTTP 基本認証で使用するユーザー名。 ストリング
パスワード いいえ HTTP 基本認証で使用するパスワード。 ストリング
HTTP メソッド はい プロキシーに使用する HTTP メソッド。 有効な値は以下のとおりです。
  • 保持
  • GET
  • POST
  • PUT
  • 削除
  • PATCH
  • HEAD
  • オプション
デフォルト値は Keepです。 Keep を使用するか、ソースからプロパティを削除すると、受信リクエストHTTPが使用されます。		 ストリング
圧縮 いいえ アップロード時にコンテンツ・エンコーディング圧縮を有効にする場合は、このチェック・ボックスを選択します。

このチェック・ボックスは、デフォルトでクリアされています。

 ブール

キャッシュ・タイプ

 いいえ キャッシュ・タイプを使用して、文書をキャッシュするかどうかを指定します。この指定により、ターゲット URL からの応答で受信した HTTP のキャッシュ制御ディレクティブを優先するかオーバーライドするかが決まります。 このプロパティーは、応答を受信した場合にのみ有効になります。応答を受信しなかった場合、ポリシーは常に、キャッシュに以前保存されていた、有効期限の切れていない応答を返します。
有効な値は以下のとおりです。
Protocol
キャッシュの動作は、RFC 7234 に従って、要求と応答の Cache-Control ヘッダーによって決定されます。

パフォーマンスを最適化するために、キャッシュ内に存在しないが、ターゲット URL から応答を受信したときにキャッシュできる可能性があるリソースに対する複数の要求を受信したゲートウェイは、ターゲット URL に対して要求を 1 つのみ送信します。残りの要求は、最初の要求に対する応答を受信し、その応答からキャッシュの動作が決定されるまで処理されません。 応答によりキャッシュが可能であることが示された場合、ゲートウェイはキャッシュされたリソースを使用してすべての待ち要求に応答します。 応答によりキャッシュが不可であることが示された場合、ゲートウェイはすべての待ち要求をターゲット URL に送信します。

このオプションは、ターゲット URL からの応答がキャッシュ可能であると想定される場合にのみ使用してください。その場合、パフォーマンスが向上し、ターゲット URL に対する要求を制限できます。 ただし、ターゲット URL からの応答がゲートウェイでのキャッシュの必要性を示すことがない場合、「キャッシュなし」オプションと比較してパフォーマンスが低下する可能性があります。

キャッシュなし
返されるキャッシュ・ヘッダーにかかわらず、ターゲット URL からの応答はゲートウェイ上にキャッシュされません。 この場合、クライアントからのすべての要求はターゲット URL に送信されます。

このオプションは、バックエンド応答を一切ゲートウェイ上にキャッシュしない場合、またはターゲット URL からの応答が、Cache-Control ヘッダー設定によるキャッシュを許可する可能性が低い場合に使用してください。

有効期間
このオプションは、「プロトコル」オプションに似ていますが、呼び出しまたはプロキシーからの正常な応答をキャッシュ内に残す時間を指定できるという点が異なります。 このオプションは、ターゲット URL からの応答がキャッシュ可能であると想定される場合にのみ使用してください。

デフォルト値は 「プロトコル」です。

 ストリング

有効期間

 いいえ キャッシュ内に応答を保存する時間を秒単位で指定します。 プロパティー 「キャッシュ・タイプ」 が Time to Liveに設定されている場合にのみ適用されます。 5 から 31708800 までの範囲内で値を指定してください。

デフォルト値は 900です。

 整数

キャッシュ・キー

 いいえ 文書のキャッシュ・エントリーの固有の ID を指定します。 このプロパティーを省略すると、URL ストリング全体がキーとして使用されます。 ストリング
エラー発生時に停止 いいえ ポリシーの実行中にスローされた場合、アセンブリー・フローを停止させるエラーを選択します。 エラー用に構成された catch フローがある場合は、スローされたエラーを処理するためにトリガーされます。 エラーがスローされ、「エラー発生時に停止」設定でエラーが選択されていない場合、またはスローされたエラーが選択されたエラーの 1 つでない場合、ポリシーの実行の完了が許可され、アセンブリー・フローが続行されます。 ストリング

応答オブジェクト変数

 いいえ 要求の応答データを格納するための変数の名前。 この変数は、「マップ」などの他のアクションで参照することができます。 ストリング
X-Forwarded見出し いいえ
このヘッダーは、以下の場合に指定できます。
  1. 指定する場合は、
    X-Forwarded-Host
    存在する場合、処理は続行します proxy ポリシーを呼び出す前にこのヘッダーが存在しない場合、このヘッダーの設定には Host ヘッダーの値が使用されます。
  2. この
    X-Forwarded-For
    すべての場合に、ヘッダーは常に設定されます。 このヘッダーは階層リンクを維持し、コンマ区切りの IP のリストをクライアントからその前にあるプロキシー (ある場合) まで表示します。
  3. 3 つのヘッダー
    X-Forwarded-Host
    ,
    X-Forwarded-Port
    および
    X-Forwarded-Proto
    が、proxy ポリシーの呼び出し時にどれも存在しない場合は、これらのヘッダーが自動的に設定されます。 このように設定しないためには、
    X-Forwarded-Host
    ヘッダーを、proxy ポリシーを呼び出す前に何らかの値に設定します。
 ストリング