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
中文 (简体)

用途

在列出作业时,Data Mover 提供以下筛选器变量:
  • 满足指定条件(包括开始时间、结束时间和状态)的作业
  • 已运行且满足指定条件(包括开始时间、结束时间、状态和优先级)的作业
  • 当前正在运行且满足指定条件(包括开始时间、状态和优先级)的作业
  • 具有冻结步骤的作业
说明
URL

/datamover/jobs

/datamover/executedJobs

/datamover/executingJobs

/datamover/jobs?freezeJobStepsOnly=value

方法 GET

请求参数 (/datamover/jobs)

此变量返回满足特定条件的作业名称的列表,包括开始时间、结束时间以及状态。如果未提供任何参数,则返回新作业和已完成作业的列表。

startTimeAfter
说明︰开始时间晚于指定时间的作业
限制︰不能与 endTimeAfter 组合使用
URL: /datamover/jobs?startTimeAfter=value
JSON 数据类型︰字符串(采用 ISO 8601 UTC 日期格式),例如︰2015-07-01T17:38:12Z
必需:否
endTimeBefore
说明︰完成时间早于指定时间的作业。
限制︰不能与 endTimeAfter 组合使用
URL: /datamover/jobs?endTimeBefore=value
JSON 数据类型︰字符串(采用 ISO 8601 UTC 日期格式),例如︰2015-07-01T17:38:12Z
必需:否
endTimeAfter
说明:完成时间晚于指定时间的作业。
限制:不能与 endTimeBeforestartTimeAfter 组合使用。
URL: /datamover/jobs?endTimeAfter=value
JSON 数据类型︰字符串(采用 ISO 8601 UTC 日期格式),例如︰2015-07-01T17:38:12Z
必需:否
freezeJobStepsOnly
说明:仅列出 freezeJobStepsOnly 设置为 true 的作业
URL: /datamover/jobs?freezeJobStepsOnly=value
接受的值:True 或 False
  • true = 列出具有冻结作业步骤的作业
  • false = 返回所有作业,不考虑冻结步骤
JSON 数据类型︰布尔
必需:否
jobName
说明︰作业名称
JSON 数据类型︰字符串
必需:否
latestJobsOnly
说明:列出守护程序中运行的最新作业。
URL: /datamover/jobs?latestJobsOnly=value
接受的值:True 或 False
  • true = 仅列出最近执行的作业
  • false = 列出所有作业
JSON 数据类型︰布尔
必需:否
status
说明︰最后一次启动状态与以下其中之一相匹配的作业:
  • NEW:所有新作业
  • INITIALIZING:所有正在初始化的作业
  • RUNNING:所有正在运行的作业
  • BLOCKED:所有已阻止的作业
  • COMPLETED:所有已成功完成的作业
  • FAILED:所有失败的作业
  • RESTARTING:所有正在重新启动的作业
  • CANCELLED:所有用户取消的作业
  • QUEUED:所有已排队的作业
URL: /datamover/jobs?status=value
JSON 数据类型︰字符串
必需:否

响应参数 (/datamover/jobs)

jobExecutionName
说明︰已启动作业名称
JSON 数据类型︰字符串
jobName
说明︰作业名称(最大字符数︰237)
JSON 数据类型︰字符串
startTime
说明︰如果作业已启动,则为开始时间;如果未启动,则为 null
JSON 数据类型︰字符串(采用 ISO 8601 UTC 日期格式),例如︰2015-07-01T17:38:12Z
endTime
说明︰如果作业已启动,则为结束时间;如果未启动,则为 null
JSON 数据类型︰字符串(采用 ISO 8601 UTC 日期格式),例如︰2015-07-01T17:38:12Z
status
说明︰作业的状态(最大字符数︰12),其中可能的值已在“请求参数”部分指定
JSON 数据类型︰字符串
Priority
说明︰如果作业已启动,则为作业优先级(最大字符数︰11),其中值为以下项之一︰
  • UNSPECIFIED
  • LOW
  • MEDIUM
  • HIGH
JSON 数据类型︰字符串

响应示例 (/datamover/jobs)

此示例显示一个开始时间晚于指定时间的作业阵列;如果未找到任何作业,则返回空阵列。
[
     {
         "jobName" :  "runningJob" ,
         "startTime" : "2015-07-16T17:14:13Z",
         "endTime" :  null ,
         "status" :  "RUNNING" ,
         "priority" :  "MEDIUM" ,
         "links" : 
          [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/executingJobs/runningJob-1417744247669"
                              
             },
             {
                 "rel" :  "past_executions" ,
                 "href" :  "http://server/datamover/executedJobs?jobName=runningJob&startTimeAfter=<value>"
                              
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/runningJob/steps"
                              
             }
         ]
     },
     {
         "jobName" :  "successfulJob" ,
         "startTime" : "2015-07-16T17:14:13Z",
         "endTime" : "2015-07-16T19:14:13Z",
         "status" :  "COMPLETED" ,
         "priority" :  "MEDIUM" ,
         "links" : 
         [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/executedJobs/successfulJob-20141204175020"
                              
             },
             {
                 "rel" :  "past_executions" ,
                 "href" :  "http://server/datamover/executedJobs?jobName=successfulJob
                                &startTimeAfter=<value>
                                "
                              
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/successfulJob/steps"
                              
             }
         ]
     },
     {
         "jobName" :  "failedJob" ,
         "startTime" : 1417744247669,
         "endTime" : 1417744323437,
         "status" :  "FAILED" ,
         "priority" :  "MEDIUM" ,
         "links" : 
         [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/executedJobs/failedJob-20141204175020"
                              
             },
             {
                 "rel" :  "past_executions" ,
                 "href" :  "http://server/datamover/executedJobs?jobName=failedJob
                                &startTimeAfter=<value>
                                "
                              
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/failedJob/steps"
                              
             }
         ]
     }
]             

请求参数 (/datamover/executedJobs)

此变量返回满足指定条件的作业名称的列表,包括新作业或正在运行的作业。

startTimeAfter
说明︰开始时间晚于指定时间的作业
限制︰不能与 endTimeAfter 组合使用
URL: /datamover/executedJobs
JSON 数据类型︰字符串(采用 ISO 8601 UTC 日期格式),例如︰2015-07-01T17:38:12Z
必需:否
endTimeBefore
说明:完成时间早于指定时间的作业
限制︰不能与 endTimeAfter 组合使用
URL: /datamover/executedJobs?endTimeBefore=value
JSON 数据类型︰字符串(采用 ISO 8601 UTC 日期格式),例如︰2015-07-01T17:38:12Z
必需:否
endTimeAfter
说明︰完成时间晚于指定时间的作业
限制:不能与 startTimeAfterendTimeBefore 组合使用
URL: /datamover/executedJobs?endTimeBefore=value
JSON 数据类型︰字符串(采用 ISO 8601 UTC 日期格式),例如︰2015-07-01T17:38:12Z
必需:否
status
说明︰最后一次运行状态与以下其中之一相匹配的作业:
  • COMPLETED:所有已成功完成的作业
  • FAILED:所有失败的作业
  • CANCELLED:所有用户取消的作业
URL: /datamover/executedJobs?endTimeBefore=value
JSON 数据类型︰字符串
必需:否
jobName
说明︰映射到指定名称的已启动作业
URL: /datamover/executedJobs?jobName=value
JSON 数据类型︰字符串
必需:否

响应参数 (/datamover/executedJobs)

jobExecutionName
说明︰已启动作业名称
JSON 数据类型︰字符串
jobName
说明︰作业名称(最大字符数︰237)
JSON 数据类型︰字符串
startTime
说明︰如果作业已启动,则为开始时间;如果未启动,则为 null
JSON 数据类型︰字符串(采用 ISO 8601 UTC 日期格式),例如︰2015-07-01T17:38:12Z
endTime
说明︰如果作业已启动,则为结束时间;如果未启动,则为 null
JSON 数据类型︰字符串(采用 ISO 8601 UTC 日期格式),例如︰2015-07-01T17:38:12Z
status
说明︰作业状态(最大字符数:11),其中可能的值已在“请求参数”部分列出
JSON 数据类型︰字符串(采用 ISO 8601 UTC 日期格式),例如︰2015-07-01T17:38:12Z
Priority
说明︰作业的优先级(如果已启动)(最大字符数︰11),其中值为以下项之一︰
  • UNSPECIFIED
  • LOW
  • MEDIUM
  • HIGH
JSON 数据类型︰字符串

RESTful API 示例 (/datamover/executedJobs)

此示例显示一个已启动作业;如果未找到任何作业,则返回空阵列。
[
     {
         "jobExecutionName" :  "successfulJob-20141204175020" ,
         "jobName" :  "successfulJob" ,
         "startTime" :"2015-07-01T17:38:12Z",
         "endTime" : "2015-07-01T19:38:12Z",
         "status" :  "COMPLETED" ,
         "priority" :  "MEDIUM" ,
         "links" : 
         [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/executedJobs/successfulJob-20141204175020"
                          
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/successfulJob/steps"
                              
             }
         ]
     },
     {
         "jobExecutionName" :  "successfulJob-20141204175111" ,
         "jobName" :  "successfulJob" ,
         "startTime" : "2015-07-02T17:38:12Z",
         "endTime" : "2015-07-02T19:38:12Z",
         "status" :  "COMPLETED" ,
         "priority" :  "MEDIUM" ,
         "links" : 
         [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/executedJobs/successfulJob-20141204175111"
                          
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/successfulJob/steps"
                              
             }
         ]
     },
     {
         "jobExecutionName" :  "failedJob-20141204175020" ,
         "jobName" :  "failedJob" ,
         "startTime" : "2015-07-03T17:38:12Z",
         "endTime" : "2015-07-03T19:38:12Z",
         "status" :  "FAILED" ,
         "priority" :  "MEDIUM" ,
         "links" : 
         [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/executedJobs/failedJob-20141204175020"
                          
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/failedJob/steps"
                              
             }
         ]
     }
]     

请求参数 (/datamover/executingJobs)

此变量返回 Data Mover 守护程序上目前正在运行的及开始时间晚于指定时间的所有作业,其中值为以下项之一︰
  • INITIALIZING
  • RUNNING
  • BLOCKED
  • RESTARTING
  • QUEUED
您可以提供以下可选参数︰
startTimeAfter
说明︰开始时间晚于指定时间的作业
限制︰不能与 endTimeAfter 组合使用
URL: /datamover/executingJobs
JSON 数据类型︰字符串(采用 ISO 8601 UTC 日期格式),例如︰2015-07-01T17:38:12Z
必需:否
status
说明︰最后一次运行状态与以下其中之一相匹配的作业:
  • COMPLETED:所有已成功完成的作业
  • FAILED:所有失败的作业
  • CANCELLED:所有用户取消的作业
URL: /datamover/executingJobs?status=value
JSON 数据类型︰字符串
必需:否

响应参数 (/datamover/executingJobs)

jobExecutionName
说明︰已启动作业名称
JSON 数据类型︰字符串
jobName
说明︰作业名称(最大字符数︰237)
JSON 数据类型︰字符串
startTime
说明︰如果作业已启动,则为开始时间;如果未启动,则为 null
JSON 数据类型︰字符串(采用 ISO 8601 UTC 日期格式),例如︰2015-07-01T17:38:12Z
status
说明︰作业状态(最大字符数:11),其中可能的值已在“请求参数”列表中指定
JSON 数据类型︰字符串
Priority
说明︰作业的优先级(如果已启动)(最大字符数︰11),其中值为以下项之一︰
  • UNSPECIFIED
  • LOW
  • MEDIUM
  • HIGH
JSON 数据类型︰字符串

RESTful API 示例 (/datamover/executingJobs)

此示例显示一个已启动作业;如果未找到任何作业,则返回空阵列。
[
         {
         "jobExecutionName" :  "runningJob-1417744247669" ,
         "jobName" :  "runningJob" ,
         "startTime" :"2015-07-16T17:14:13Z",
         "status" :  "RUNNING" ,
         "priority" :  "MEDIUM" ,
         "links" : 
          [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/runningJobs/runningJob-1417744247669"
                          
             },
             {
                 "rel" :  "history" ,
                 "href" :  "http://server/datamover/executedJobs?jobName=runningJob&startTimeAfter=<value>"
                          
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/runningJob/steps"
                              
             }
         ]
     }
] 

请求参数 (/datamover/jobs?freezeJobStepsOnly=value)

freezeJobStepsOnly
说明:将冻结作业步骤设置为 true 的作业
JSON 数据类型︰布尔
必需:否
接受的值:True 或 False
  • true = 列出具有冻结作业步骤的作业
  • false = 返回所有作业,不考虑冻结步骤

响应参数 (/datamover/jobs?freezeJobStepsOnly=value)

jobExecutionName
说明︰已启动作业名称
JSON 数据类型︰字符串
jobName
说明︰作业名称(最大字符数︰237)
JSON 数据类型︰字符串
links
说明:指向作业状态、过去的作业执行情况和作业步骤的链接列表
JSON 数据类型︰JSON 数组(LinkType
Priority
说明︰作业的优先级(如果已启动)(最大字符数︰11),其中值为以下项之一︰
  • UNSPECIFIED
  • LOW
  • MEDIUM
  • HIGH
JSON 数据类型︰字符串
startTime
说明:作业开始时间
JSON 数据类型︰字符串(采用 ISO 8601 UTC 日期格式),例如︰2015-07-01T17:38:12Z
status
说明︰作业的状态(最大字符数︰12),其中可能值已在“请求参数”说明中指定
JSON 数据类型︰字符串