Viewpoint System Health REST APIs | Data Objects | Teradata Viewpoint - 17.10 - Data Objects - 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)

SystemHealthWs

{
    "systemId": 4,               // Internal ID of the monitored system
    "systemName": "1410e10x",    // Name of the monitored system
    "systemType": "TERADATA",    // Type of the monitored system (TERADATA, ASTER, MLENGINE, HADOOP)
    "timestamp": 1398362240000,  // Timestamp when the system health was calculated
    "health": "HEALTHY",         // Calculated system health (HEALTHY, DEGRADED, CRITICAL, DOWN, UNKNOWN)
    "links": [ {
        "rel": "self",
        "href": "http://viewpoint/api/public/systemHealth/systems/4"
    }, {
        "rel": "metrics",
        "href": "http://viewpoint/api/public/systemHealth/systems/4/metrics"
    }, {
        "rel": "downComponents",
        "href": "http://viewpoint/api/public/systemHealth/systems/4/downComponents"
    }, {
        "rel": "thresholds",
        "href": "http://viewpoint/api/public/systemHealth/systems/4/thresholds"   
    }, {
        "rel": "descriptions",
        "href": "http://viewpoint/api/public/systemHealth/systems/4/descriptions"
    }
 ]
}

SystemHealthMetricWs

{
    "metricName": "CPU_USER",    // Name of the metric
    "metricLabel": "CPU User",   // i18n label for the metric
    "status": "ENABLED",         // Status of the metric (ENABLED, DISABLED, VIEW_ONLY)
    "statusLabel": "Enabled",    // i18n label for the status
    "startTime": 1398362240000,  // Timestamp passed as the startTime parameter (null if parameter not provided)
    "endTime": 1398364039000,    // Timestamp passed as the endTime parameter (null if parameter not provided)
    "thresholds": {
        "degraded": 80,  // Configured degraded threshold for this metric
        "critical": 90,  // Configured critical threshold for this metric
        "max": 100       // Maximum value for this metric (can be null if metric is unbounded)
    },
    "data": [
        {
            "timestamp": 1398362240000,  // Timestamp when data was collected
            "value": 73.24               // Value of the metric at that point in time
        },
        {
            "timestamp": 1398362300000,
            "value": 87.45
        }
        ...
    ]
} 

SystemHealthMetricsWsV2

{
      "metricName": "CPU_UTILIZATION",    // Name of the metric
      "metricLabel": "CPU Utilization",   // i18n label for the metric
      "metricUnit": "units.percent",      // Unit for the metric
      "metricValue": 5.622499942779541,   // Value for the metric
      "status": "ENABLED",                // Status of the metric (ENABLED, DISABLED, VIEW_ONLY)
      "statusLabel": "Enabled",           // i18n label for the metric
      "startTime": null,                  // Timestamp passed as the startTime parameter (null if parameter not provided)
      "endTime": null,                    // Timestamp passed as the endTime parameter (null if parameter not provided)
      "thresholds": {
        "degraded": 90,                   // Configured degraded threshold for this metric 
        "critical": 95,                   // Configured critical threshold for this metric
        "max": 100                        // Maximum value for this metric (can be null if metric is unbounded)
      },
      "data": [
        {
          "timestamp": 1615361405920,     // Timestamp when data was collected
          "value": 6.201666831970215      // Value of the metric at that point in time
        },
        {
          "timestamp": 1615362005921,
          "value": 5.622499942779541
        }
		...
      ]
}

DownComponentsWs

{
    "componentType": "VPROC",  // Type of the component (VPROC, NODE, or BYNET on Teradata, any of the service components on Hadoop)
    "description": "17324"     // Description of the component (VPROC, NODE, or BYNET ID on Teradata, host name of the service component on Hadoop)
}

MetricThresholdsWs

{
    "metricName": "NODE_CPU_SKEW",  // Name of the metric
    "metricLabel": "Node CPU Skew", // i18n label for the metric
    "status": "ENABLED",            // Status of the metric (ENABLED, DISABLED, VIEW_ONLY)
    "statusLabel: "Enabled",        // i18n label for the metric
    "thresholds": {
        "degraded": 80,  // Configured degraded threshold for this metric
        "critical": 90,  // Configured critical threshold for this metric
        "max": 100       // Maximum value for this metric (can be null if metric is unbounded)
    },
    "metricDependency": {                 // null if no metric dependency
        "metricName": "CPU_UTILIZATION",  // Name of the metric upon which this metric has a dependency
        "enabled": true,                  // Whether or not the dependency is enabled
        "threshold": 85                   // Threshold for dependency
    }
}

DescriptionWs

{
    "health": "HEALTHY",         // System health key (HEALTHY, DEGRADED, CRITICAL, DOWN, UNKNOWN)
    "label": "Good",             // System health label
    "description: "Custom text"  // System health description
}

MetricsSummaryWs

{
  "collectTime": 1615362009719,         //Collection time
  "downComponents": [],                 //Down components or services for a single system
  "servicesBad": null,                  //Number of services in a critical state
  "servicesConcerning": null,           //Number of services in a degraded state
  "viewDetail": false,
  "systemHealthMetricsWsV2": [
    {
      "metricName": "CPU_UTILIZATION",    // Name of the metric
      "metricLabel": "CPU Utilization",   // i18n label for the metric
      "metricUnit": "units.percent",      // Unit for the metric
      "metricValue": 5.622499942779541,   // Value for the metric
      "status": "ENABLED",                // Status of the metric (ENABLED, DISABLED, VIEW_ONLY)
      "statusLabel": "Enabled",           // i18n label for the metric
      "startTime": null,                  // Timestamp passed as the startTime parameter (null if parameter not provided)
      "endTime": null,                    // Timestamp passed as the endTime parameter (null if parameter not provided)
      "thresholds": {
        "degraded": 90,                   // Configured degraded threshold for this metric 
        "critical": 95,                   // Configured critical threshold for this metric
        "max": 100                        // Maximum value for this metric (can be null if metric is unbounded)
      },
      "data": [
        {
          "timestamp": 1615361405920,     // Timestamp when data was collected
          "value": 6.201666831970215      // Value of the metric at that point in time
        },
        {
          "timestamp": 1615362005921,
          "value": 5.622499942779541
        }
		...
      ]
    }    
  ]
}