NSX-T Data Center REST API

# *************************************************************************** # Copyright 2020-2024 VMware, Inc. All rights reserved. VMware Confidential. # ***************************************************************************

MetricItem (schema)

Metric item

This type represents the value of a metric and related information.

Name	Description	Type	Notes
degraded_threshold	Degraded threshold The threshold for determining the status as DEGRADED.	number
down_threshold	Down threshold The threshold for determining the status as DOWN.	number
error_message	error message If metric status is not UP, this field show its possible reason.	string
metric_data_type	Metric data type Metric value data type, including STRING, INTEGER, FLOAT and BOOLEAN.	string	Enum: STRING, INTEGER, FLOAT, BOOLEAN
metric_description	Metric description If the metric name cannot intuitively express the information of the metric, a detailed description is required here.	string
metric_id	Metric ID The unique id assigned to the metric name.	int
metric_name	Metric name Name of the Metric. It acts as the 'key' to access the metric.	string
metric_value_counter	Counter metric value Metric original value for COUNTER type.	integer
metric_value_gauge	Gauge metric value Metric original value for GAUGE type.	number
metric_value_histogram	Histogram metric value Metric original value for HISTOGRAM type.	HistogramMetricValue
metric_value_string	String metric value Metric original value for STRING type.	string
metric_value_vector	Vector metric value Metric original value for VECTOR type.	array of number
status	Status value It is the metric status value, if the metric is status type, or can be converted to status type according to threshold. Only the unified appliance cluster level status uses [STABLE, DOWN, DEGRADED, UNAVAILABLE], and others use [UP, DOWN, DEGRADED, UNKNOWN].	string	Enum: UP, DOWN, DEGRADED, UNKNOWN, STABLE, UNAVAILABLE
tags	Metric tags The tags of this metric.	array of MetricTag