タスクをアーティファクトの新しいバージョンで更新 - Cloud

APIを経由してタスクでアーティファクトのバージョンを更新

Version
Cloud
Language
日本語 (日本)
Product
Talend Cloud
Module
Talend API Designer
Talend API Tester
Talend Data Preparation
Talend Data Stewardship
Talend Management Console
Content
ジョブデザインと開発 > Updating Tasks
executables/tasks/<task_id>エンドポイントを使って、タスクをアーティファクトの新しいバージョンで更新します。

始める前に

API呼び出しの発行に使用されるアカウントに[Operations - Manage] (操作 - 管理) (ID: TMC_OPERATOR)権限があることを確認します。

このタスクについて

このセクションでは、Talend API TesterはAPI呼び出しを発行してタスクのリストを取得する方法のデモンストレーションに使用されます。

手順

  1. まだ生成していない場合は、[Users] (ユーザー)ページで、自分のアカウント用にパーソナルアクセストークンを生成します。
  2. ブラウザーでTalend API Testerを開き、[Method] (メソッド) リストで[PUT]を選択します。
  3. [Method] (メソッド)ドロップダウンリストの横にあるフィールドに、使用するエンドポイントをhttps://api.<your_environment>.cloud.talend.com/v2.6/executables/tasks/<task_id>という形式で入力します。
  4. [HEADERS] (ヘッダー)エリアで[Add header] (ヘッダーを追加)をクリックし、表示される[name] (名前)フィールドにAuthorizationを、[value] (値)フィールドにBearerとパーソナルアクセストークンをそれぞれ入力します。Bearerとパーソナルアクセストークンは空白で区切ります。
  5. [BODY] (ボディ)エリアに、更新されるタスク名、ワークスペースID、使用される新しいアーティファクトのIDを入力します。

    例え

    {
      "name": "task_name",
      "description": "",
      "workspaceId": "workspace_id",
    
      "artifact": {
        "id": "id_of_the_artifact_to_be_updated",    
        "version": "target_version_of_this_artifact (for example, 0.1.22.20212710014123)"
      }
    }
    この例には、タスクの更新に必要なパラメーターのみが含まれています。

    [artifactId]パラメーターは更新されるアーティファクトを識別して、[workspaceId]パラメーターはタスクを取得するワークスペースを示します。タスクはAPIリクエストを介して取得するか、Talend Cloud Management Consoleで見つかります。

    • API:
      • https://api.<your_environment>.cloud.talend.com/v2.6/artifactsGETを使う
      • ワークスペースのhttps://api.<your_environment>.cloud.talend.com/v2.6/workspacesGETを使う
    • Talend Cloud Management Consoleで、ワークスペースからアーティファクトリストを開いた後に、更新されるアーティファクトを開いて、そのIDを確認します。ワークスペースのIDは、[Edit workspace] (ワークスペースを編集)ページのURLに表示されます。
  6. [Send] (送信)をクリックし、タスクを更新するようリクエストを送信します。

タスクの結果

レスポンスのボディ内に、ステータスコード200がタスク詳細と共に返されます。新しいアーティファクトが使用されていることがわかります。以下の例では、レスポンス内にタスクがどのように表示されるはずかを示します。
{
  "id": "5c1111d7a4186a4eafed0587",
  "name": "Hello world task",
  "description": "task detail description",
  "workspace": {
    "id": "57f64991e4b0b689a64feed2",
    "name": "Personal",
    "description": "workspace detail description",
    "owner": "admin",
    "type": "custom",
    "environment": {
      "id": "57f64991e4b0b689a64feed3",
      "name": "Development",
      "description": "environment detail description",
      "default": true
    }
  },
  "version": "0.1",
  "artifact": {
    "createDate": "2021-11-22T13:13:27.608Z",
    "updateDate": "2021-11-22T13:13:27.608Z",
    "id": "id_of_the_artifact_to_be_updated",
    "name": "my_artifact",
    "version": "0.1.22.20212710014123" (The new  artifact version)
  },
  "tags": [
    "tag1",
    "tag2"
  ],
  "connections": {
    "aws": "5d405e381f40e07fbab6757c",
    "googledrive": "5d405e831f40e07fbab6757d"
  },
  "parameters": {
    "parameter_p1": "1111",
    "custom_parameter": "custom"
  },
  "resources": {
    "resource_file_f1": "5d567ad48f68ae1a1e16e4a4"
  },
  "autoUpgradeInfo": {
    "autoUpgradable": false,
    "overrideWithDefaultParameters": false
  }
}

実際の運用では、自分のスクリプトを開発して、前のセクション(アーティファクトのバージョンを更新する必要があるタスクを取得)で取得した各タスクでこのリクエストを自動的に発行できます。

左側にある[Downloads] (ダウンロード)タブで、この種のスクリプトの例をダウンロードし、スクリプトの先頭にリスト表示される必要なパラメーターに適切な値を追加し、それを使ってタスクの更新を自動化できます。このスクリプトは、デモンストレーション目的のためのみデザインされています。Talendはこのスクリプトのサポートサービスを提供しません。