invoke

invoke ポリシーは、API を呼び出すために使用します。

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

invoke ポリシーの形式は次のとおりです。
- invoke:
  title: title
  description: description
  target-url: URL_of_target_API
  tls-profile: TLS_profile_to_be_used
  verb: method_type
  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_invoke_result
  cache-key: unique_identifier_of_the_document_cache_entry
  cache-response: cache_behavior
  cache-ttl: cache_time_to_live
次の表に、invoke ポリシーのプロパティーを示します。
表 1. invoke ポリシーのプロパティー
プロパティー 必須 説明 データ型
title いいえ ポリシーのタイトル。 ストリング
description いいえ ポリシーの説明。 ストリング
target-url はい ターゲット API の URL。 ストリング
tls-profile いいえ 使用する TLS プロファイル。 ストリング
verb いいえ

操作メソッド・タイプ。

有効は値は以下のとおりです。
  • 保持
  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
  • HEAD
  • OPTIONS

デフォルト値は GET です。ただし、Keep に設定した場合、またはプロパティーがソースから省略された場合は、着信要求の HTTP メソッドが使用されます。

 ストリング
timeout いいえ タイムアウト値 (秒数)。デフォルト値は 60 です。 整数
compression いいえ データをアップロードする前に gzip を使用して圧縮するかどうかを指定します。デフォルト値は false です。 ブール
username いいえ 認証が必要な場合のユーザー名。 ストリング
password いいえ 認証が必要な場合のパスワード。 ストリング
output いいえ 呼び出しの結果を保存する場所を指定します。デフォルトでは、context.message 変数に呼び出しの結果 (本文、ヘッダー、statusCode、statusMessage) が保存されます。 このプロパティーを使用して、呼び出し結果を格納する代替位置を指定します。 ストリング

DataPower Gateway のみcache-key

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

DataPower Gateway のみcache-response

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

デフォルト値は protocol です。

 ストリング

DataPower Gateway のみcache-ttl

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

デフォルト値は、900 です。

 整数

例

- 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 日