Monitored Systems Web Service APIs | Supported Operations | Teradata Viewpoint - Supported Operations - Teradata Data Lab - Teradata Viewpoint

Teradata® Viewpoint and Teradata® Data Lab API Reference Guide - 23.04
Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
Lake
VMware
Product
Teradata Data Lab
Teradata Viewpoint
Release Number
23.04
Published
April 2023
Language
English (United States)
Last Update
2023-05-05
dita:mapPath
tvo1678987866029.ditamap
dita:ditavalPath
ft:empty
dita:id
B035-2215
Product Category
Analytical Ecosystem
HTTP Method URL Parameters and Path Variables Description Response
GET /api/public/monitoredSystems Optional Parameter
  • type: Type of systems to return (TERADATA, MANAGED, ASTER, MLENGINE, TASM_MODEL, HADOOP, QUERYGRID, PRESTO)
 Provides a list of the configured monitored systems Array of MonitoredSystem objects
POST /api/public/monitoredSystems Optional Request Parameters:
  • type: Type of systems to pass (TERADATA, MANAGED, ASTER, MLENGINE, HADOOP, QUERYGRID, PRESTO)
  • enableCollectors: - true to enable the standard collectors for the system (Default: true)
  • enableCleanup: true to enable the cleanup schedule and all log table cleanups for the system. Valid for Teradata systems only. (Default: false)
Required Parameter - Request Body
  • MonitoredSystem object (see example in the Data Objects section)
 Adds a new monitored system to Viewpoint.
  • At least one login must be provided.
  • The "id" field of the login object cannot be included.
  • The first login in the list will be the login assigned to execute all data collectors.
 When successful, 201 response code with URI of created resource in the Location HTTP response header.

When unsuccessful, 4xx or 5xx response code with ReturnStatus object in body.
GET /api/public/monitoredSystems/{systemId} Path Variable
  • systemId: The id of the system
 Provides a single configured monitored system A single MonitoredSystem object
PUT /api/public/monitoredSystems/{systemId} Required Parameter - Request Body
Path Variable
  • systemId: The id of the system
 Updates an existing Viewpoint-monitored system (none)
DELETE /api/public/monitoredSystems/{systemId} Path Variable
  • systemId: The id of the system
 Removes an existing monitored system from Viewpoint (none)
POST /api/public/monitoredSystems/{systemId}/grants Required Parameter - Request Body
  • Grant object
Path Variable
  • systemId: The id of the system
 Executes the grants. This request is only valid against a database system. Array of GrantResult objects