Monitored Systems Web Service REST APIs | Data Objects | Teradata Viewpoint - Data Objects - Teradata Data Lab - Teradata Viewpoint

Teradata® Viewpoint and Teradata® Data Lab API Reference Guide - 24.04

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
Lake
VMware
Product
Teradata Data Lab
Teradata Viewpoint
Release Number
24.04
Published
April 2024
Language
English (United States)
Last Update
2024-04-29
dita:mapPath
qko1711972084905.ditamap
dita:ditavalPath
ft:empty
dita:id
prd1525780132746
Product Category
Analytical Ecosystem

ReturnStatus

{
    "message": "Access Denied. Error ID: 15524dfd-6806-4f95-a0b5-e59a64cbb833"
}

MonitoredSystem

{
"system_id": 4,                     // The Viewpoint internal system ID
  "enabled": true,                   // Whether or not the system is enabled
  "type": "TERADATA",                // Type of the system (TERADATA, MANAGED, ASTER, MLENGINE,TASM_MODEL, HADOOP, QUERYGRID, PRESTO)
  "tasm_type": "UNKNOWN",              
  "name": " 1410e10x",         // Name of the system that is used throughout Viewpoint
  "host": " calvin",            // Hostname or IP address of the system
  "site_id": " TDCALVIN1",    // Site ID for server management (read only)
  "site_id_collected": true, // Whether or not the site ID was collected from the monitored system (read only)  
  "session_char_set": " UTF8", // The character set to use for making SQL connections (TERADATA systems only)
  "monitor_char_set": " ASCII", // The character set to use for making monitor partition (PM/API) connections (TERADATA systems only)
  "jdbc_client_char_set": "", // Any additional JDBC flags to pass in the connection string (TERADATA systems only)
  "additional_auth_options": : [ "LDAP" ] // Array of additional authentication options on top of default (TERADATA systems only) (LDAP, TD2) ,
 "logins": [
    {
      "id": 145,                     // ID of the login
      "user_name": "viewpoint",                         // Username
      "password": "scret,                               // Password
      "account_string": "",         // Teradata account string (TERADATA systems only)
      "login_type": "TERADATA", // Login type (TERADATA systems only) (TERADATA, TDWM, STATS),
      "auth_mech": "TD2" // Authentication mechanism (TERADATA systems only) (TD2, LDAP, DEFAULT)
    }
  ],
  "time_zone": "string",
  "hadoop_license": "TERADATA",
  "cluster_type": "HADOOP",
  "system_family": 0,
  "cluster_name": "string"
}

Grant

{
"username": "viewpoint",
"version": "14.10", // Must be of the form "xx.yy", where xx is the major version of Teradata, and yy is the minor version
"authentication": {
             "username": "viewpoint", // Username 
             "password": "secret", // Password
             "account_String": "",   // Teradata account string (TERADATA systems only)                                   
             "auth_mech": "TD2"   // Authentication mechanism (TERADATA systems only) (TD2, LDAP, DEFAULT) 
            "session_char_set": "UTF8" // Character set
 }
  }

GrantResult

{
    "sql": "replace macro console.dbscontrol as (;);",
    "error": "",
    "success": true
}