List Configuration | RESTful API | Teradata Data Mover - List Configuration (RESTful API) - Teradata Data Mover

Teradata® Data Mover User Guide
Product
Teradata Data Mover
Release Number
17.05
Published
October 2020
Language
English (United States)
Last Update
2020-11-18
dita:mapPath
xxl1591023586203.ditamap
dita:ditavalPath
mpm1591127278842.ditaval
dita:id
B035-4101
lifecycle
previous
Product Category
Analytical Ecosystem

Purpose

Display configuration settings for the daemon, stored procedures, table-driven interface of the daemon, and performance settings for the daemon.

There are two variations of the API that display information for the following:
  • Specified property
  • All properties specified in the request body
Item Description
URL

/datamover/daemonProperties/propertyName

/datamover/daemonProperties
Method GET

Request Parameters

No request parameters required.

Response Parameters

propertyName
Description: Configuration property name
JSON Data Type: String
Required: Yes
values
Description: Property values per system
JSON Data Type: JSON Array (valueType)
Required: Yes
unit
Description: Unit of the value
JSON Data Type: String
Required: No
description
Description: Additional information
JSON Data Type: String
Required: Yes
systemPairs
Description: System pairs used to force job direction
JSON Data Type: JSON Array (systemPairType)
Required: No
groupPools
Description: User group pools
JSON Data Type: JSON Array (userGroupType)
Required: No
targetUserPools
Description: Systems for target user pool
JSON Data Type: JSON Array (systemType)
Required: No
neverTargetSystems
Description: Systems never used as the target system
JSON Data Type: JSON Array (String)
Required: No
defaultDatabases
Description: Databases used as default target or staging databases at system level
JSON Data Type: JSON Array (systemLevelDatabaseType)
Required: No

Response Examples

This example shows a specified property. 
{
    "propertyName": "agentCollector.agentHeartbeatWaitMillis",
    "values":
    [
        {
            "value": "600000",
            "system": "ALL"
        }
    ],
    "description": "Purpose: To set the amount of time to wait for an Agent heartbeat before assuming it has gone out of service in milliseconds. Default: 600000"
}

This example shows all properties specified in response body.

Related information