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-CHS
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 数据类型︰整数
输出级别:2
endTime
说明︰作业的结束时间;如果未执行,则为 null
JSON 数据类型︰长整数
输出级别:1
jobExecutionId
说明:作业执行标识
JSON 数据类型︰长整数
输出级别: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
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"
        }
    ]
}