Purpose
The list_tasks RESTful API displays a list of queued and running tasks, including information about status and execution.
The list_job_definition 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
- agent
- Description: Agent currently running the task, or '-' if queued
- jobName
- Description: Name of the associated job
- priority
- Description: Priority of the associated job, where possible value is one of the following:
- UNSPECIFIED
- LOW
- MEDIUM
- HIGH
- queue
- Description: Queue in which the task is waiting, or NOT_QUEUED if running
- queueOrder
- Description: Task position in the queue, or '-' if running
- sourceSystem
- Description: Database system from which task is moving data
- status
- Description: Status of the task, where the value is one of the following:
- QUEUED
- RUNNING
- targetSystem
- Description: Database system to which task is moving data
- taskId
- Description: Task ID
- userPool
- Description: Pool name, or '-' if none used
- utility
- Description: Utility on which task depends
Status Codes
If the command executes without error, the API returns status code 200 in the response header and nothing in the response body.
If an error occurs during execution, the API returns a non-200 status code in the response header and an error message in JSON format in the response body.
Response Example
[ { "taskID": "138", "jobName": "ast-1", "taskStatus": "RUNNING", "agentName": [ ], "queueName": "NOT_QUEUED", "utility": "JDBC", "srcSystem" : "10.25.46.85", "targetSystem": "sdlc7614.labs.teradata.com" "jobPriority" : "MEDIUM", "lastUpdateTime" : 1450480158375 } ]