ジョブのステータス(RESTful API) - Teradata Data Mover

概要

status RESTful API は、以下のURLとメソッドを使用して、実行されたジョブのステータスを表示します。

リクエストのパラメータ

outputLevel

URL: /datamover/executingJobs/executed-job-name?outputLevel=value

URL: /datamover/executedJobs/executed-job-name?outputLevel=value

説明: ジョブ ステータスの出力レベルを指定します。次のテーブルに、出力レベルのオプションを定義します。

出力レベル	説明
1	全体的なジョブのステータス(デフォルト)
2	各ジョブ ステップのステータス
3	各ジョブ タスクのステータス
4	詳細なログ情報 ジョブのステータスがNEWのとき詳細なジョブ情報を取得するには、outputLevel=4を使用する必要があります。

outputLevelパラメータを指定しない場合、デフォルトのoutput_level 1に設定されます。

必須: いいえ

応答のパラメータ

currentStep

説明: ジョブの最新ステップID、実行されなかった場合はnull

JSONデータ型: INTEGER型

出力レベル: 2

endTime

説明: ジョブの終了時刻、実行されなかった場合はnull

JSONデータ型: 文字列

出力レベル: 1

estimatedJobSize

説明: ジョブ サイズの信頼度の高い見積もり

JSONデータ型: long

出力レベル: 1

jobExecutionId

説明: ジョブの実行ID

JSONデータ型: long

出力レベル: 1

jobName

説明: ジョブ名(最大文字数: 237)

JSONデータ型: 文字列

出力レベル: 1

jobExecutionName

説明: ジョブの実行名

JSONデータ型: 文字列

出力レベル: 1

lifeCycle

説明: ジョブの作成と実行中に全イベントを一覧表示

JSON配列: オブジェクト(LifeCycleStatus)

出力レベル: 3

log

説明: ユーティリティのログ出力を表示します

JSONデータ型: 文字列

出力レベル: 4

rowCount

説明: 行数の検証ステップが存在する場合、ソース オブジェクトとターゲット オブジェクトの行数の確認結果

JSON配列: オブジェクト(RowCountStatus)

出力レベル: 3

startTime

説明: ジョブの開始時刻、実行されなかった場合はnull

JSONデータ型: 文字列

出力レベル: 1

status

説明: ジョブのステータス(最大文字数は12)。使用可能な値は、リクエストのパラメータのstatusの説明に記載されています。

JSONデータ型: 文字列

出力レベル: 1

steps

説明: ジョブの最後のステップをすべて一覧表示、実行されなかった場合はnull

JSON配列: オブジェクト(StepType)

出力レベル: 2

streams

説明: ストリームを表示します (存在する場合)

JSON配列: オブジェクト(StreamInfo)

出力レベル: 3

submitTime

説明: ジョブが送信された時刻

JSONデータ型: 文字列

出力レベル: 1

tasks

説明: 各オブジェクトの個々のタスクすべてを表示、実行されなかった場合はnull

JSON配列: オブジェクト(TaskStatus)

出力レベル: 3

応答の例

{
  "jobName" : "job1-20200128112954",
  "jobExecutionName" : "job1-20200128112954",
  "jobExecutionId" : 25,
  "currentStep" : 3,
  "startTime" : 1580239796717,
  "endTime" : 1580239811907,
  "status" : "COMPLETED",
  "steps" : [ {
    "id" : 1,
    "status" : "COMPLETED",
    "type" : "VERIFY_JOB_OBJECTS",
    "startTime" : 1580239799361,
    "endTime" : 1580239800076
  }, {
    "id" : 2,
    "status" : "COMPLETED",
    "type" : "COMPARE_DDL",
    "startTime" : 1580239800186,
    "endTime" : 1580239802157
  }, {
    "id" : 3,
    "status" : "COMPLETED",
    "type" : "MOVE_TABLE_DATA",
    "startTime" : 1580239802203,
    "endTime" : 1580239811792
  } ],
  "tasks" : [ {
    "id" : 2570,
    "movePhase" : "VALIDATING",
    "status" : "COMPLETE",
    "timestamp" : 1580239799774
  }, {
    "id" : 2571,
    "movePhase" : "COMPARE_DDL",
    "status" : "COMPLETE",
    "agentName" : "Agent1",
    "utility" : "SQL",
    "timestamp" : 1580239801883
  }, {
    "id" : 2572,
    "movePhase" : "MOVING_DATA",
    "status" : "COMPLETE",
    "objectType" : "table",
    "agentName" : "Agent1",
    "utility" : "DSA",
    "timestamp" : 1580239804392
  } ],
  "links" : [ {
    "rel" : "self",
    "href" : "https://localhost:1443/datamover/executedJobs/job1-20200128112954?outputLevel=3"
  } ]