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

用途

list_tasks RESTful API 显示已排队和正在运行的任务列表,包括有关状态和执行的信息。

list_tasks RESTful API 使用以下 URL 和方法︰
说明
URL /datamover/tasks
方法 GET

请求参数

jobName
说明︰列出与指定作业名称关联的任务
必需:否
taskId
说明︰列出与指定任务 ID 关联的任务
必需:否
agentName
说明︰列出在指定代理上运行的任务
必需:否
taskStatusMode
说明︰按以下指定模式之一列出任务︰
  • A (ALL)︰所有模式
  • Q (QUEUED)︰所有已排队的任务
  • R (RUNNING):所有正在运行的任务
必需:否
如果您未指定模式,Data Mover 将包括所有模式。

响应参数

agentNames
说明︰当前正在运行任务的代理,如果处于排队状态,则为“-”
JSON 数据类型:字符串数组
jobName
说明︰关联作业的名称
JSON 数据类型︰字符串
jobPriority
说明︰关联作业的优先级,可能的值为以下值之一︰
  • UNSPECIFIED
  • LOW
  • MEDIUM
  • HIGH
JSON 数据类型︰字符串
lastUpdateTime
说明:上次更新的时间。
JSON 数据类型︰长整数
queueName
说明︰任务正在其中等待的队列,如果任务正在运行,则为 NOT_QUEUED
JSON 数据类型︰字符串
queueOrder
说明︰任务在队列中的位置,如果正在运行,则为“-”
JSON 数据类型︰字符串
srcSystem
说明:任务从中移动数据的数据库源系统
JSON 数据类型︰字符串
targetSystem
说明︰任务向其移动数据的数据库系统
JSON 数据类型︰字符串
taskId
说明:任务 ID
JSON 数据类型︰整数
taskStatus
说明︰任务的状态,为以下值之一︰
  • QUEUED
  • RUNNING
JSON 数据类型︰字符串
targetUserPoolName
说明︰池名称,如果没有使用池,则为“-”
JSON 数据类型︰字符串
utility
说明︰任务依赖的实用程序
JSON 数据类型︰字符串

响应示例

[
    {
        "taskID": "499",
        "jobName": "ast-1",
        "taskStatus": "QUEUED",
        "agentNames": [ ],
        "queueName": "LOAD_SLOT",
        "utility": "TPTAPI_LOAD",
        "srcSystem" : "10.25.46.85",
        "targetSystem": "sdt16849.labs.teradata.com"
        "jobPriority" : "LOW",
        "lastUpdateTime" : 1536693540772 
    }
]