Purpose
The list_tasks RESTful API displays a list of queued and running tasks, including information about status and execution.
The list_tasks RESTful API uses the following URL and method:
Item | Description | ||
---|---|---|---|
URL | /datamover/tasks | ||
Method | GET |
Request Parameters
- jobName
- Description: List tasks associated with specified job name
- taskId
- Description: List tasks associated with specified task ID
- agentName
- Description: List tasks running on specified agent
- taskStatusMode
- Description: List tasks in one of the following specified modes:
- A (ALL): All modes
- Q (QUEUED): All queued tasks
- R (RUNNING) All running tasks
Response Parameters
- agentNames
- Description: Agent currently running the task, or '-' if queued
- jobName
- Description: Name of the associated job
- jobPriority
- Description: Priority of the associated job, where possible value is one of the following:
- UNSPECIFIED
- LOW
- MEDIUM
- HIGH
- lastUpdateTime
- Description: Time of last update.
- queueName
- Description: Queue in which the task is waiting, or NOT_QUEUED if running
- queueOrder
- Description: Task position in the queue, or '-' if running
- srcSystem
- Description: Database source system from which the task is moving data
- targetSystem
- Description: Database system to which task is moving data
- taskId
- Description: Task ID
- taskStatus
- Description: Status of the task, where the value is one of the following:
- QUEUED
- RUNNING
- targetUserPoolName
- Description: Pool name, or '-' if none used
- utility
- Description: Utility on which task depends
Response Example
[ { "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 } ]