list_agents RESTful API - Teradata Data Mover

Teradata Data Mover User Guide

Product
Teradata Data Mover
Release Number
16.10
Published
June 2017
Language
English (United States)
Last Update
2018-03-29
dita:mapPath
kmo1482331935137.ditamap
dita:ditavalPath
ft:empty
dita:id
B035-4101
lifecycle
previous
Product Category
Analytical Ecosystem

Purpose

The list_agents command lists the Data Mover agents connected to the Data Mover daemon. The list_agents RESTful API uses the following URL and method:

Item Description
URL /datamover/agents
Method GET

Request Parameters

The list_agents RESTful API does not require specific request parameters.

Response Parameters

If the command executes without error, the API returns the status code 200, along with an array of JSON objects describing the agents.

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."
}