タスクの一覧表示(RESTful API) - Teradata Data Mover

目的

list_tasks RESTful APIには、実行待ちのタスクと実行中のタスクのリストが、状態と実行に関する情報とともに表示されます。

リクエストのパラメータ

jobName

説明: 指定したジョブ名に関連するタスクを一覧表示します。

必須: いいえ

taskId

説明: 指定したタスクIDに関連するタスクを一覧表示します。

必須: いいえ

agentName

説明: 指定されたエージェントで実行されているタスクを一覧表示します。

必須: いいえ

taskStatusMode

説明: 次のいずれかの指定されたモードのタスクをリストします。

• A (ALL): すべてのモード
• Q (QUEUED): 実行待ちのすべてのタスク
• R (RUNNING) 実行中のすべてのタスク

必須: いいえ

モードを指定しない場合、Data Moverにはすべてのモードが含まれます。

応答のパラメータ

agentNames

説明: 現在タスクを実行しているエージェント、または実行待ちの場合は'-'

JSONデータ型: 文字列配列

jobName

説明: 関連付けられているジョブの名前

JSONデータ型: 文字列

jobPriority

説明: 関連付けられたジョブの優先順位。可能な値は以下のいずれかです。

• UNSPECIFIED
• LOW
• MEDIUM
• HIGH

JSONデータ型: 文字列

lastUpdateTime

説明: 最終更新時刻。

JSONデータ型: long

queueName

説明: タスクが待機しているキュー。または実行中の場合はNOT_QUEUED

JSONデータ型: 文字列

queueOrder

説明: キュー内のタスクの位置、または実行中の場合は'-'

JSONデータ型: 文字列

srcSystem

説明: タスクがデータを移動している元のデータベース ソース システム

JSONデータ型: 文字列

targetSystem

説明: タスクがデータを移動している先のデータベース システム

JSONデータ型: 文字列

taskId

説明: タスクID

JSONデータ型: INTEGER型

taskStatus

説明: タスクのステータス。値は以下のいずれかです。

• QUEUED
• RUNNING

JSONデータ型: 文字列

targetUserPoolName

説明:プール名、または使用しない場合は'-'

JSONデータ型: 文字列

utility

説明: タスクが依存するユーティリティ

JSONデータ型: 文字列

応答の例

[
    {
        "taskID": "499",
        "jobName": "ast-1",
        "taskStatus": "QUEUED",
        "agentNames": [ ],
        "queueName": "LOAD_SLOT",
        "utility": "TPTAPI_LOAD",
        "srcSystem" : "10.25.46.85",
        "targetSystem": "sdt16849.labs.teradata.com"
        "jobPriority" : "LOW",
        "lastUpdateTime" : 1536693540772 
    }
]