REST エンドポイントの呼び出しタスク

REST エンドポイントの呼び出しタスクを使用すると、インテグレーションからサードパーティの REST API を呼び出すことができます。REST API 呼び出しからのレスポンスは統合変数で使用でき、他のダウンストリーム タスクで使用できます。

始める前に

  • REST API 呼び出しの認証エンドポイントに接続するには、OAuth 2.0 プロファイルを作成済みであるか、統合にユーザー管理のサービス アカウントを接続していることを確認します。API で認証が不要な場合は、タスク構成ペインの [Authentication profile] フィールドを空のままにしておくことができます。構成リストを表示するには、構成プロパティをご覧ください。

    統合に OAuth 2.0 プロファイルとユーザー管理のサービス アカウントの両方が構成されている場合は、デフォルトで OAuth 2.0 プロファイルが認証に使用されます。OAuth 2.0 プロファイルとユーザー管理のサービス アカウントのどちらも構成されていない場合、実行は失敗します。

  • 統合にサービス アカウントが関連付けられている場合は、REST エンドポイント URL に基づいて、必要な IAM ロールをそのサービス アカウントに付与します。たとえば、REST エンドポイント URL が Cloud Storage サービスを呼び出す場合は、Cloud Storage サービスに必要な IAM ロールを付与します。

    サービス アカウントへのロールの付与については、サービス アカウントに対するアクセス権の管理をご覧ください。

  • Google Cloud プロジェクトの Apigee Integration で VPC Service Controls が設定されていないことを確認します。

REST エンドポイントの呼び出しタスクを構成する

REST エンドポイントの呼び出しタスクを構成するには:

  1. Apigee UI で、Apigee 組織を選択します。
  2. [Develop] > [Integrations] の順にクリックします。
  3. 既存のインテグレーションを選択するか、[Create Integration] をクリックして新しいインテグレーションを作成します。

    新しいインテグレーションを作成する場合:

    1. [Create Integration] ダイアログで名前と説明を入力します。
    2. サポートされているリージョンのリストから、インテグレーションのリージョンを選択します。
    3. [Create] をクリックします。

    インテグレーション デザイナーでインテグレーションが開きます。

  4. インテグレーション デザイナーのナビゲーション バーで、[+ Add a task/trigger] > [Tasks] の順にクリックして、使用可能なタスクのリストを表示します。
  5. 統合エディタで [Call REST Endpoint] 要素をクリックして配置します。
  6. デザイナーで [Call REST Endpoint] 要素をクリックし、[Call REST Endpoint] タスク構成ペインを表示します。
  7. 次の表に示すように、タスクの構成プロパティを使用して、表示されるフィールドを構成します。

    プロパティへの変更は自動的に保存されます。

構成プロパティ

次の表に、REST エンドポイントの呼び出しタスクの構成プロパティを示します。

プロパティ データ型 説明
ラベル 文字列 省略可: タスクのラベルを追加します。
認証 文字列 省略可: 外部システムへの接続の認証の詳細を構成して保存します。詳細については、Apigee Integration で認証プロファイルを作成するをご覧ください。
エンドポイントのベース URL 文字列 クエリ パラメータのない REST エンドポイント URL。
HTTP メソッド なし 使用する HTTP メソッド。

以下の HTTP メソッドのいずれかを選択できます。

  • DELETE
  • GET
  • HEAD
  • PATCH
  • POST
  • PUT
URL クエリ文字列パラメータ クエリ文字列キー: 文字列

値: 文字列

 REST API 呼び出しに必要なクエリ パラメータです。

クエリ パラメータは Key-Value ペアの形式です。キーはキー名、値は対応するキーの値です。プラス（+）アイコンをクリックすると、複数の Key-Value ペアを入力できます。
HTTP ヘッダー HTTP ヘッダーキー: 文字列

値: 文字列

 REST API 呼び出しに必要な HTTP ヘッダーです。

HTTP ヘッダーは Key-Value ペアの形式です。key はキー名、value は対応するキーの値です。プラス（+）アイコンをクリックすると、複数の Key-Value ペアを入力できます。
リダイレクトのフォロー ブール値 URL リダイレクトを行います。

次のいずれかの値を選択できます。

  • True: エンドポイントのベース URL が別の URL に転送される場合に、リダイレクト URL を呼び出します。
  • False: エンドポイントのベース URL が別の URL に転送される場合に、リダイレクト URL を呼び出しません。
タスクが HTTP エラーで失敗する ブール値 REST API 呼び出しが失敗した場合の例外処理の方法。HTTP レスポンス コードが 4xx または 5xx の場合、REST エンドポイントの呼び出しは失敗します。エラーコードのリストについては、エラーコードをご覧ください。他の HTTP レスポンス コードの場合は、レスポンスでエラーコードとエラー メッセージを返します。

次のいずれかの値を選択できます。

  • True : 例外をスローします。
  • False: 例外をスローしません。ただし、レスポンスでエラーコードとエラー メッセージを返します。
レスポンス ヘッダー（<タスク名>） 文字列 REST API のレスポンスからの圧縮されていないレスポンス ヘッダー。
レスポンス本文（<タスク名>） 文字列 REST API のレスポンスからの圧縮されていないレスポンスの本文。
レスポンス ステータス（<タスク名>） 文字列 REST API レスポンスからの HTTP レスポンス コードと、対応するコードテキスト。

ベスト プラクティス

REST エンドポイントの呼び出しタスクに適用される使用量上限については、使用量上限をご覧ください。

エラー処理方法

タスクのエラー処理方法では、一時的なエラーによってタスクが失敗した場合のアクションを指定します。エラー処理方式と、さまざまな種類のエラー処理方式の詳細については、エラー処理方法をご覧ください。

4xx エラーまたは 5xx エラーの再試行戦略を処理する方法については、レスポンスのステータスに基づいて残りの呼び出し元タスクを再試行する方法のブログをご覧ください。