16.10 - GET (Specified Server) - Teradata Ecosystem Manager

Teradata Ecosystem Manager API Reference

prodname
Teradata Ecosystem Manager
vrm_release
16.10
created_date
June 2017
category
Programming Reference
featnum
B035-3204-067K

Purpose

Get server details.

URL

/emrest/datadiscovery/servers/{server-name}

HTTP Method

GET

Request Parameters

Path variable:server-name

Response

A Response body in JSON with following parameters:
Name Data Type Description
server_type String Type of server
data_center Data Center String
script_exec_user A user on the server String
script_exec_password Password for script_exec_user String
alias_list List of server aliases JSON array
"alias_list": [ { "alias_name": "string", "alias_type": "string" }, ... ... ]
td_packrate Packrate for server of server_type TD Integer
webhcatalog_server_name WebHCatalog server name Integer
webhcatalog_port WebHCatalog server port number Integer
dm_job_control Flag to see if Data Mover jobs can be instrumented from Ecosystem Manager Boolean
dm_security Flag to see if security is enabled on Data Mover Boolean
dm_job_user Data Mover job username String
dm_job_password DM job password String
dm_rest_encryption Flag to see if Data Mover ssl is enabled Boolean
dm_rest_port Port number for Data Mover REST Integer

Status

A status code of 200 is returned on a successful completion. A non-200 status code is returned if an error occurs.

Example: Getting Server Details using the API

{
    "server_name": "pixel",
    "server_type": "DMC",
    "data_center": "15.11-Deploy",
    "dm_job_control": true,
    "dm_security": false,
    "dm_rest_encryption": false,
    "dm_rest_port": 1080
}