Invoke (invoke)

Invoke ポリシーを適用して、アセンブリー内から別のサービスを呼び出します。バックエンドからの応答は変数 message.body または応答オブジェクト変数 (定義されている場合) のいずれかに保存されます。このポリシーは、JSON データまたは XML データに使用でき、アセンブリー内で複数回適用できます。

概要

このポリシーを以下の API フローに付加できます。

REST
SOAP

重要: IBM® API Connect for IBM Cloud™ (SaaS オファリング)を使用している場合、公開するサービスは、インターネット上で見ることができる必要があり、社内イントラネット内からのみアクセス可能にすることはできません。ただし、API Manager で構成された TLS プロファイルを使用して、API Connect の API ゲートウェイと、DMZ を経由してインターネットに公開するサービスとの間の通信チャネルを保護することができます。Bluemix Secure Gateway サービスを使用して、IBM API Connect for IBM Cloud からご使用のオンプレミス・ゲートウェイ・サービスへの安全なアクセスを提供することもできます。詳しくは、「Secure Gateway の概要」を参照してください。

注: Invoke ポリシーでは、マルチパート・フォーム・データを使用した応答 (つまり、応答が Content-Type: multipart/related に設定されている場合) はサポートされません。

プロパティー

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

表 1. Invoke ポリシーのプロパティー
プロパティー・ラベル	必須	説明	データ型
タイトル	はい	ポリシーのタイトル。デフォルト値は、`invoke` です。	ストリング
説明	いいえ	ポリシーの説明。	ストリング
URL	はい	ターゲット・サービスの URL を指定します。 SOAP API の場合、URL がデフォルトで追加されます。可能であれば、インポートされた WSDL で定義されている情報から、「呼び出し URL」の値はあらかじめ入力されます。 Collective でホストされているアプリケーションを呼び出すには、追加の構成が必要です。詳しくは、Collective にホストされているアプリケーション・エンドポイントを呼び出すためのアセンブリーの変更を参照してください。	ストリング
TLS プロファイル (TLS profile)	いいえ	データ伝送をセキュアにするために使用する TLS プロファイルを指定します。	ストリング
タイムアウト	はい	エンドポイントからの応答を待機する時間 (秒)。デフォルト値は `60` です。	整数
ユーザー名	いいえ	HTTP 基本認証で使用するユーザー名。	ストリング
パスワード	いいえ	HTTP 基本認証で使用するパスワード。	ストリング
HTTP メソッド	はい	呼び出しで使用する HTTP メソッド。有効な値は次のとおりです。保持 GET POST PUT DELETE PATCH HEAD OPTIONS デフォルト値は `GET` です。ただし、`Keep` に設定した場合、またはプロパティーがソースから削除された場合は、着信要求の HTTP メソッドが使用されます。	ストリング
圧縮	いいえ	アップロード時にコンテンツ・エンコーディング圧縮を有効にする場合は、このチェック・ボックスを選択します。このチェック・ボックスは、デフォルトでクリアされています。	ブール
キャッシュ・タイプ	いいえ	キャッシュ・タイプを使用して、文書をキャッシュするかどうかを指定します。この指定により、ターゲット URL からの応答で受信した HTTP のキャッシュ制御ディレクティブを優先するかオーバーライドするかが決まります。このプロパティーは、応答を受信した場合にのみ有効になります。応答を受信しなかった場合、ポリシーは常に、キャッシュに以前保存されていた、有効期限の切れていない応答を返します。有効な値は次のとおりです。プロトコルキャッシュの動作は、RFC 7234 に従って、要求と応答の Cache-Control ヘッダーによって決定されます。パフォーマンスを最適化するために、キャッシュ内に存在しないが、ターゲット URL から応答を受信したときにキャッシュできる可能性があるリソースに対する複数の要求を受信したゲートウェイは、ターゲット URL に対して要求を 1 つのみ送信します。残りの要求は、最初の要求に対する応答を受信し、その応答からキャッシュの動作が決定されるまで処理されません。応答によりキャッシュが可能であることが示された場合、ゲートウェイはキャッシュされたリソースを使用してすべての待ち要求に応答します。応答によりキャッシュが不可であることが示された場合、ゲートウェイはすべての待ち要求をターゲット URL に送信します。このオプションは、ターゲット URL からの応答がキャッシュ可能であると想定される場合にのみ使用してください。その場合、パフォーマンスが向上し、ターゲット URL に対する要求を制限できます。ただし、ターゲット URL からの応答がゲートウェイでのキャッシュの必要性を示すことがない場合、「キャッシュなし」オプションと比較してパフォーマンスが低下する可能性があります。キャッシュなし返されるキャッシュ・ヘッダーにかかわらず、ターゲット URL からの応答はゲートウェイ上にキャッシュされません。この場合、クライアントからのすべての要求はターゲット URL に送信されます。このオプションは、バックエンド応答を一切ゲートウェイ上にキャッシュしない場合、またはターゲット URL からの応答が、Cache-Control ヘッダー設定によるキャッシュを許可する可能性が低い場合に使用してください。存続時間このオプションは、「プロトコル」オプションに似ていますが、呼び出しまたはプロキシーからの正常な応答をキャッシュ内に残す時間を指定できるという点が異なります。このオプションは、ターゲット URL からの応答がキャッシュ可能であると想定される場合にのみ使用してください。デフォルト値は「プロトコル」です。	ストリング
存続時間	いいえ	キャッシュ内に応答を保存する時間を秒単位で指定します。このプロパティーが適用されるのは、「キャッシュ・タイプ」プロパティーが「`存続時間`」に設定されている場合だけです。5 から 31708800 までの範囲内で値を指定してください。デフォルト値は、`900` です。	整数
キャッシュ・キー	いいえ	文書のキャッシュ・エントリーの固有の ID を指定します。このプロパティーを省略すると、URL ストリング全体がキーとして使用されます。	ストリング
応答オブジェクト変数	いいえ	要求の応答データを格納するための変数の名前。デフォルトでは、`message.body` 変数に呼び出しの応答 (本文、ヘッダー、statusCode、statusMessage) が保存されます。このプロパティーを使用して、呼び出しの応答を格納する代替位置を指定します。この変数は、「マップ」などの他のアクションで参照することができます。注: 応答を `message.body` に保存する場合は、「応答オブジェクト変数」プロパティーをブランクのままにして、値 `message.body` を指定しないようにしてください。	ストリング

例

- invoke:
  title: get the account status
  target-url: https://example.com/accounts/{id}?status={status}
  tls-profile: MyTLSProfile
  verb: POST
  timeout: 60
  compression: false 
  
  username: MyUser
  password: MyPassword

最終更新: 2017 年 10 月 31 日