16.10 - GET (Specified Database) - 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 database details.

URL

/emrest/datadiscovery/databases/{database-name}

HTTP Method

GET

Request Parameters

Path variable:database-name

Response

Response body in JSON with the following parameters.
Name Description Data Type
database_name Name of the database String
servers Server details for the database Any array of JSON (Parameters show in following table.)
Servers JSON Parameters
Name Description Data Type
server_name Name of the server String
server_type Type of server String
db_user Database logon user String
db_password Database logon password String
ast_port Aster connectivity port Integer
ast_schema Aster database schema String
hcatalog_server_name Hadoop hcatalog server String
hcatalog_port Hadoop hcatalog port Integer
hdp_user Hadoop hdp user String
sqlh_server_name SQL-H server String
sqlh_db_user SQL-H db user String
sqlh_db_password SQL-H db password String
webhcatalog_port Hadoop webhcatalog port 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 Database Details using the API

{
    "servers": [
        {
            "server_name": "sdlc5103.labs.teradata.com",
            "server_type": "AST",
            "db_user": "realdb1",
            "ast_schema": "public",
            "ast_port": 2406
        }
    ],
    "database_name": "mydatabase"
}