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

Teradata® Data Mover ユーザー ガイド

Product
Teradata Data Mover
Release Number
16.20
Published
2021年11月
Content Type
ユーザー ガイド
Publication ID
B035-4101-107K-JPN
Language
日本語 (日本)

概要

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

アイテム 説明
URL /datamover/executedJobs/executed-job-name

/datamover/executingJobs/executed-job-name

メソッド GET

リクエストのパラメータ

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データ型: 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データ型: long
出力レベル: 1
status
説明: ジョブのステータス(最大文字数は12)。使用可能な値は、リクエストのパラメータのstatusの説明に記載されています。
JSONデータ型: 文字列
出力レベル: 1
steps
説明: ジョブの最後のステップをすべて一覧表示、実行されなかった場合はnull
JSON配列: オブジェクト(StepType)
出力レベル: 2
streams
説明: ストリームを表示します (存在する場合)
JSON配列: オブジェクト(StreamInfo)
出力レベル: 3
tasks
説明: 各オブジェクトの個々のタスクすべてを表示、実行されなかった場合はnull
JSON配列: オブジェクト(TaskStatus)
出力レベル: 3

応答の例

次の例では、最も一般的なステータスのジョブ実行配列を示します。生成されるリンクは、ジョブのステータスによって異なります。
{
    "jobName": "dmsmptodmsmp2createtest",
    "jobExecutionName": "dmsmptodmsmp2createtest-20141219094827",
    "startTime": 1419011314588,
    "status": "RUNNING",
    "links" : [
        {
            "rel": "self"
            "href": "http://server/datamover/executingJobs/dmsmptodmsmp2createtest-20141219094827"
        },
        {
            "rel": "executed_status"
            "href": "http://server/datamover/executedJobs/dmsmptodmsmp2createtest-20141219094827"
        }
    ]
}
{
    "jobName": "dmsmptodmsmp2createtest",
    "jobExecutionName": "dmsmptodmsmp2createtest-20141219094827",
    "startTime": 1419011314588,
    "status": "RUNNING",
    "steps":
    [
        {
            "id": 1,
            "type": "VERIFY_JOB_OBJECTS",
            "startTime": 1419011317674,
            "endTime": 1419011331750,
            "durationTime": 14,
            "status": "COMPLETED"
        },
        {
            "type": "MOVE_TABLE_DATA",
            "startTime": 1419011332324,
            "endTime": 1419011373457,
            "status": "COMPLETED",
            "durationTime": 41
        }
    ],
    "tasks":
    [
        {
            "id": 15,
            "parentName": "dmintegrationtestuser",
            "objectName": "test1",
            "objectType": "table",
            "movePhase": "MOVING_DATA",
            "status": "ARCHIVE",
            "totalRowsProcessed": 1002,
            "totalBytesProcessed": 32558,
            "timeStamp": 1419011343828,
            "agentName": "Agent2",
            "utility": "ARC",
            "sessionsSpecified": 2,
            "sessionsUsed": "2"
            "dataStreams": 1
        }
    ],
    "streams":
    [
        {
            "utility": "ARC",
            "operator": "Archive",
            "agentName": "Agent2",
            "taskID": 15,
            "streamID": 1,
            "bytesProcessed": 97674,
            "processSpeed": 49033,
            "timestamp": 1419011349791,
            "objectName": "dmintegrationtestuser.test3"
        }
    ],
    "log": "Step 1 is complete",
    "links" : [
        {
            "rel": "self"
            "href": "http://server/datamover/executingJobs/dmsmptodmsmp2createtest-20141219094827"
        },
        {
            "rel": "executed_status"
            "href": "http://server/datamover/executedJobs/dmsmptodmsmp2createtest-20141219094827"
        }
    ]
}