proxy

proxy ポリシーを適用して、操作内の別の API をプロキシー処理します (特に、大きなペイロードを呼び出す必要がある場合)。

ゲートウェイのサポート

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

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

製品情報

proxy ポリシーに関する以下の考慮事項を念頭に置いておいてください。
  • アセンブリーごとに呼び出すことができる proxy ポリシーは 1 つのみです。
  • 複数の proxy ポリシーがアセンブリーの相互に排他的なブランチに含まれている場合は、それらのポリシーを適用できます。
  • proxy ポリシーを使用して、マルチパート・フォーム・データを返すことができます。つまり、応答が以下のように設定されている場合です。Content-Type: multipart/relatedただし、 proxy はアセンブリー内の最終ポリシーでなければなりません。そうでない場合、受信した応答が操作され、マルチパート・フォーム・データが失われます。
  • proxy ポリシーは、条件付きポリシー内にある場合、API で実行される 最終 ポリシーでなければなりません。 後でさらに処理が必要な場合は、 proxy ポリシーではなく invoke ポリシーを使用します。
  • proxy ポリシーは現在、バックエンドから返されたロケーション・ヘッダーの再書き込みを試行しません。
proxy ポリシーの構造は、以下のとおりです。
- proxy:
  version: version
  title: title
  description: description
  target-url: URL_of_target_API
  tls-profile: TLS_profile_to_be_used
  verb: method_type
  http-version: HTTP_version
  timeout: timeout_value_in_seconds
  compression: is_data_to_be_compressed
  username: username_if_authentication_required
  password: password_if_authentication_required
  output: location_of_the_proxy_result
  cache-key: unique_identifier_of_the_document_cache_entry
  cache-response: cache_behavior
  cache-putpost-response: response_caching_behavior
  cache-ttl: cache_time_to_live
  stop-on-error: errors_that_stop_the_flow

プロパティ－

この表は、proxy ポリシーのプロパティーについて説明しています。
表 2. proxy ポリシーのプロパティー
プロパティー 必須 説明 データ・タイプ
version はい ポリシーのバージョン番号 ストリング
title いいえ ポリシーのタイトル。 ストリング
description いいえ ポリシーの説明。 ストリング
target-url はい ターゲット API の URL。 ストリング
tls-profile いいえ 使用する TLS プロファイル。 ストリング
verb いいえ

操作メソッド・タイプ。

有効値:
  • 保持
  • GET
  • POST
  • PUT
  • 削除
  • パッチ
  • ヘッド
  • オプション

デフォルト値は Keepです。

 ストリング
http-version いいえ HTTP バージョン。 デフォルト値は 1.1です。 ストリング
timeout いいえ タイムアウト値 (秒数)。 デフォルト値は 60です。 整数
compression いいえ データをアップロードする前に gzip を使用して圧縮するかどうかを指定します。 デフォルト値は falseです。 ブール値
username いいえ 認証が必要な場合のユーザー名。 ストリング
password いいえ 認証が必要な場合のパスワード。 ストリング
output いいえ プロキシー処理の結果を保存する場所を指定します。 プロキシー処理の結果 (本文、ヘッダー、statusCode、statusMessage) は、デフォルトで context.message 変数に保存されます。 アセンブリー開発者は、出力プロパティーを使用して、プロキシー処理の結果を保存するための追加の場所を指定することができます。 ストリング

cache-key

 いいえ 文書のキャッシュ・エントリーの固有の ID を指定します。 ストリング

cache-response

 いいえ キャッシュの応答タイプ。
有効値:
  • protocol: キャッシュの動作は、要求と応答の Cache-Control ヘッダーによって定義されます。
  • no-cache: キャッシュは使用されません。 ただし、ドキュメントが既にキャッシュ内にある場合は、そのドキュメントがキャッシュから取得されます。
  • time-to-live: 指定された時間だけ、応答がキャッシュ内に格納されます。

デフォルト値は protocolです。

 ストリング
cache-putpost-response いいえ POST 要求と PUT 要求からの応答をキャッシュに入れるかどうかを指定します。 POST 要求および PUT 要求からの応答をキャッシングすると、サーバー負荷を軽減し、クライアント要求への応答の待ち時間を減らすことができます。

デフォルト値は falseです。

 ブール値

cache-ttl

 いいえ キャッシュ内に応答を保存する時間を秒単位で指定します。 このプロパティーは、cache-response プロパティーが time-to-live に設定されている場合のみ適用されます。 値は、5 から 31708800 の範囲で入力します。

デフォルト値は 900です。

注： ユーザーがToolkitのログイン・パス（ ?from=TOOLKIT を含む URL ）を使ってサインインする場合、生成されるAPIキーのTTL（time-to-live）は5分固定です。
 整数
stop-on-error いいえ ポリシーの実行中にスローされると、フローが停止する原因となるエラーをリストします。 エラー用に構成された catch フローがある場合は、スローされたエラーを処理するためにトリガーされます。 エラーがスローされ、「エラー発生時に停止」プロパティーでエラーが指定されていない場合、またはスローされたエラーが指定されたエラーの 1 つでない場合、ポリシーの実行の完了が許可され、アセンブリー・フローが続行されます。 ストリング