System Health REST API Supported Operations | Teradata Viewpoint - 17.10 - Supported Operations (v2) - Teradata Data Lab - Teradata Viewpoint

Teradata® Viewpoint and Teradata® Data Lab API Reference Guide

Product
Teradata Data Lab
Teradata Viewpoint
Release Number
17.10
Release Date
October 2021
Content Type
Programming Reference
Publication ID
B035-2215-101K
Language
English (United States)
HTTP URL Parameters Description Response
GET /api/v2/public/systemHealth/systems Optional Parameter
  • time: Timestamp to indicate point in time for when system health data must be provided. Defaults to the current time.
Provides the system health overview for all systems on this Viewpoint server Array of SystemHealthWs objects
GET /api/v2/public/systemHealth/systems/{systemId}
Path Variable
  • systemId: The id of the system
Optional Parameter
  • time: Timestamp to indicate point in time for when system health data must be provided. Defaults to the current time.
Provides the system health overview for a single system SystemHealthWs object
GET /api/v2/public/systemHealth/systems/{systemId}/descriptions Path Variable
  • systemId: The id of the system
Provides a list of the configured system health descriptions for a single system Array of DescriptionWs objects
GET /api/v2/public/systemHealth/systems/{systemId}/downComponents
Path Variable
  • systemId: The id of the system
Optional Parameter
  • time: Timestamp to indicate point in time for when system health data must be provided. Defaults to the current time.
Provides a list of the down components or services for a single system Array of DownComponentsWs objects
GET /api/v2/public/systemHealth/systems/{systemId}/metrics
Path Variable
  • systemId: The id of the system
Optional Parameters
  • time: Timestamp to indicate point in time for when system health data must be provided. Defaults to the current time.
  • startTime: Timestamp to indicate start time of range for which system health data should be provided
  • endTime: Timestamp to indicate end time of range for which system health data should be provided

If neither parameter is provided, the current data point for each metric is returned. If both parameters are provided, the data points within the range will be returned. Specifying only one parameter or the other is not supported and an error is returned.

Provides the metric data for a single system MetricsSummaryWs object
GET /api/v2/public/systemHealth/systems/{systemId}/thresholds Path Variable
  • systemId: The id of the system
Provides a list of the configured thresholds for a single system Array of MetricThresholdWs objects