proxy

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

proxy ポリシーに関する以下の考慮事項を念頭に置いておいてください。

1 つのアセンブリーで呼び出すことのできる proxy ポリシーは 1 つだけです。
アセンブリーの相互に排他的なブランチ内に proxy ポリシーが含まれている場合、複数の proxy ポリシーを適用することができます。
proxy ポリシーを使用して、マルチパート・フォーム・データを使用した応答 (つまり、応答が Content-Type: multipart/related に設定されている場合) を返すことができます。ただし、proxy はアセンブリー内の最後のポリシーでなければなりません。そうしないと、受信したデータが操作され、マルチパート・フォーム・データが失われてしまいます。
proxy ポリシーは現在、バックエンドから返されたロケーション・ヘッダーの再書き込みを試行しません。

proxy ポリシーの構造は、以下のとおりです。

- proxy:
  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-ttl: cache_time_to_live

この表は、proxy ポリシーのプロパティーについて説明しています。

表 1. proxy ポリシーのプロパティー
プロパティー	必須	説明	データ型
title	いいえ	ポリシーのタイトル。	ストリング
description	いいえ	ポリシーの説明。	ストリング
target-url	はい	ターゲット API の URL。	ストリング
tls-profile	いいえ	使用する TLS プロファイル。	ストリング
verb	いいえ	操作メソッド・タイプ。有効は値は以下のとおりです。保持 GET POST PUT DELETE PATCH HEAD OPTIONS デフォルト値は、`保持`です。	ストリング
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-ttl	いいえ	キャッシュ内に応答を保存する時間を秒単位で指定します。このプロパティーは、cache-response プロパティーが `time-to-live` に設定されている場合のみ適用されます。5 から 31708800 までの範囲内で値を指定してください。デフォルト値は、`900` です。	整数

最終更新: 2017 年 10 月 31 日