状态作业 (RESTful API) - Teradata Data Mover

Teradata® Data Mover 用户指南

Product
Teradata Data Mover
Release Number
17.20
Published
2022 年 9 月
Language
中文 (简体)
Last Update
2022-10-12
dita:mapPath
zh-CN/tsn1650877444606.ditamap
dita:ditavalPath
zh-CN/mpm1591127278842.ditaval
dita:id
B035-4101
Product Category
Analytical Ecosystem

概览

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
estimatedJobSize
描述:估计的最高作业大小
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
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"
  } ]