List Agents | RESTful API | Teradata Data Mover - 17.10 - List Agents (RESTful API) - Teradata Data Mover

Teradata® Data Mover User Guide

Product
Teradata Data Mover
Release Number
17.10
Release Date
June 2021
Content Type
User Guide
Publication ID
B035-4101-061K
Language
English (United States)

Purpose

List agents using the following URL and method:

Item Description
URL /datamover/agents
Method GET

Request Parameters

No request parameters required.

Response Parameters

agentName
Description: Name that identifies the agent.
JSON Data Type: String
agentHostName
Description: Name of the host running the agent.
JSON Data Type: String
agentVersion
Description: Data Mover version for the agent.
JSON Data Type: Version
maxConcurrentTasks
Description: Maximum number of concurrent tasks the agent can run.
JSON Data Type: Integer
currentTaskCount
Descriptions: Number of tasks the agent is currently running.
JSON Data Type: Integer
major
Description: Number corresponding to the major version.
JSON Data Type: String
minor
Description: Number corresponding to the minor version.
JSON Data Type: String
maintenance
Description: Maintenance release number.
JSON Data Type: String
efix
Description: efix release number.
JSON Data Type: String

Response Examples

[
{
  "agentName" : "AgentBond",
  "agentHostName" : "dm-agent7",
  "agentVersion" : {
    "major" : "16",
    "minor" : "00",
    "maintenance" : "00",
    "efix" : "00"
  },
  "maxConcurrentTasks" : 5,
  "currentTaskCount" : 0
},
{
  "agentName" : "AgentKay",
  "agentHostName" : "dm-agent4",
  "agentVersion" : {
    "major" : "16",
    "minor" : "00",
    "maintenance" : "00",
    "efix" : "00"
  },
  "maxConcurrentTasks" : 5,
  "currentTaskCount" : 0
}
]

This example shows an error message.

{
    "message": "Unable to communicate with DM Daemon. Make sure the broker url and port are correct."
}