メイン コンテンツをスキップする 補完的コンテンツへスキップ

API経由でプレパレーションを自動化

Talend Cloud Data Preparationアプリケーションの[Run] (実行)機能に加えて、API呼び出しを使い、ほとんど設定なしでプレパレーションを実行することもできます。

このオプションによって、Qlik Application Automationやその他のサードパーティツールを使い、プレパレーションの実行をスケジュールして自動化することもできるようになります。

この例では、データベースに保存された顧客データが含まれているデータセットに基づき、customers_preparationという既存のプレパレーションを使用します。このプレパレーションはデータにフォーマット処理を部分的に適用しており、新しいデータセットに対して実行されています。API呼び出しを使用すれば、このプレパレーションを簡単に再実行し、受信データを定期的にクリーニングできます。以下のドキュメンテーションで、プレパレーションを実行するための4つの主なステップ: (プレパレーションをリスト表示、実行を開始、実行を監視、履歴を取得)について説明します。

情報メモヒント: 実行APIは、自動化済みAPI実行で問題を引き起こす可能性があるTalend Cloud Data Preparationインターフェイスからユーザーによって手動でトリガーされ、最後に成功した実行に対応する実行設定を自動的に選択します。お使いのプレパレーションがAPI経由で実行できるようになったら、それを複製して専用のフォルダーに追加することをお勧めします。これによって、手動実行がそのプレパレーションを妨げることはなくなります。

このシナリオで使用するAPIエンドポイントのドキュメントを参照したい場合は、お使いの環境に応じたSwaggerドキュメンテーションのページを開き、Talend Data Preparation - Run APIを選択します。詳細は、Talend Data Preparation REST APIドキュメントへのアクセスをご覧ください。

始める前に

API経由でプレパレーションを実行するためには、以下の条件が満たされている必要があります:
  • 所有者として、または共有経由でプレパレーションにアクセスできること。
  • 少なくとも一度、Talend Cloud Data Preparationインターフェイスからプレパレーションファイルを手動で起動したことがあること。
  • プレパレーションのデスティネーションがDirect downloadではないこと。
  • 所有者として、または共有経由でデスティネーションデータセットにアクセスできること。
  • プレパレーションの手動実行が成功していること。

プレパレーションIDを取得

最初のステップは、エンドポイントを使い、互換性があるプレパレーションをリスト表示して、実行したいプレパレーションのidを取得することです。このステップで使用するエンドポイントの名前は、List preparationsです。

手順

  1. GETメソッドを使い、次のエンドポイントを入力します: 
    https://<tdp_environment>/transform/preparations/automation/preparations

    この例と次の例にある<tdp_environment>は、Talend Cloud Data PreparationインスタンスのURLに相当します。データセンターに応じて使用するURLの詳細は、Talend Cloudのアプリケーションにアクセスをご覧ください。

  2. リクエストを送信します。

    レスポンスヘッダーは次のようになります:

    [
  {
    "id": "74604d94-c013-4a58-b3c6-00b0075a35f4",
    "name": "customers_preparation",
    "folder": "preparations"
  }
]

    フォルダーフィールドの/は、プレパレーションがTalend Cloud Data Preparationのルートフォルダーにあることを意味します。別のフォルダーにある場合は、/<folder_1>/<subfolder_1>となります。

タスクの結果

取得したプレパレーションID (この例では74604d94-c013-4a58-b3c6-00b0075a35f4)をコピーします。これは、次のステップでプレパレーションを開始するために必要となります。プレパレーションidは、Talend Cloud Data Preparationで開かれているプレパレーションのURLから取得することもできます。

プレパレーションを実行

取得したプレパレーションidを使って、プレパレーションを実行するためのエンドポイントを呼び出します。このステップで使用するエンドポイントの名前は、Run preparationです。

手順

  1. POSTメソッドを使い、次のエンドポイントを入力します: 
    https://<tdp_environment>/transform/preparations/automation/preparations/<preparation_id>/runs
  2. リクエストを送信します。

    レスポンスヘッダーは次のようになります:

    {
  "id": "848df626-1389-40b9-a7ba-5719faf12e86"
}

タスクの結果

プレパレーションの実行が開始されます。この場合に取得されたidは"run id"であり、"preparation id"ではありません。id値 (この例では848df626-1389-40b9-a7ba-5719faf12e86)をコピーします。これは、監視エンドポイントに必要となります。

プレパレーションの実行を監視

実行が開始された後は、別のエンドポイントを使い、前のステップで取得した実行idでステータスを監視できます。このステップで使用するエンドポイントの名前は、Get runです。

手順

  1. GETメソッドを使い、次のエンドポイントを入力します: 
    https://<tdp_environment>/transform/preparations/automation/runs/<run_id>
  2. リクエストを送信します。

    レスポンスヘッダーは次のようになります:

    {
  "id": "848df626-1389-40b9-a7ba-5719faf12e86",
  "preparationId": "74604d94-c013-4a58-b3c6-00b0075a35f4",
  "status": "FINISHED",
  "start": "2024-07-25T21:03:49.919Z",
  "duration": "PT41.278S"
}

    ステータスは次のいずれかです:

    • QUEUEING
    • RUNNING
    • FINISHED
    • ERROR
    • NO_MORE_AVAILABLE_EXECUTOR
    • SEMANTIC_TYPES_UNAVAILABLE

タスクの結果

statusフィールドのレスポンスヘッダーに、プレパレーションの実行が終了したことが示されます。実行中にエラーが発生した場合のレスポンスには、エラーの原因特定に役立つ完全ログも含まれます。

実行履歴を取得

このプレパレーションはAPIを使って少なくとも一度は開始されているので、プレパレーションidを使えばこの特定のプレパレーションの実行履歴を参照できるようになります。このステップで使用するエンドポイントの名前は、Get run historyです。

手順

  1. GETメソッドを使い、次のエンドポイントを入力します: 
    https://<tdp_environment>/transform/preparations/automation/preparations/<preparation_id>/runs
  2. リクエストを送信

    レスポンスヘッダーは次のようになります:

    [
  {
    "id": "848df626-1389-40b9-a7ba-5719faf12e86",
    "preparationId": "74604d94-c013-4a58-b3c6-00b0075a35f4",
    "status": "FINISHED",
    "start": "2024-07-25T21:03:49.919Z",
    "duration": "PT41.278S"
  }
]

タスクの結果

最後の実行とそのステータスの要約を確認できます。この例のレスポンスには1回の実行しか表示されていませんが、複数回実行した場合はさらに表示されます。

レスポンスで取得される履歴は、APIを使って開始された実行のみを示します。逆に、Talend Cloud Data Preparationインターフェイスの[Run history] (実行履歴)は、アプリケーションで手動で実行されたもののみを示します。

このページは役に立ちましたか?

このページまたはコンテンツにタイポ、ステップの省略、技術的エラーなどの問題が見つかった場合はお知らせください。

こちらにフィードバックをお寄せください