NSX-T Data Center REST API

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

MetricMetadata (schema)

Metric metadata

The health metrics metadata.

Name Description Type Notes
is_status Is status

Indicate if this metric is status type.
boolean Default: "False"
metric_data_type Metric data type

The data type of the health metric.
string Enum: STRING, INTEGER, FLOAT, BOOLEAN
metric_description Metric description

The description of the health metric.
string
metric_errors Metric errors

The errors of the health metric.
array of MetricError
metric_id Metric ID

The unique id of the health metric.
int
metric_kblink Metric kb link

If the metric is not health, the kb link could provide recommendations.
string
metric_name Metric name

The name of the health metric.
string
metric_tags Metric tags

The tag name list of the health metric.
array of string
metric_unit Metric unit

The unit of the health metric.
string Enum: BYTES, KILOBYTES, MEGABYTES, MILLISECOND, MICROSECOND, PERCENTAGE
metric_value_type Metric value type

The value type of the health metric.
string Enum: STRING, HISTOGRAM, COUNTER, GAUGE
repeatable_metric Metric repeatable

Indicate if this metric has multiple instances with different tags.
boolean Default: "False"
service_name Service name

If the metric is service level, it shows the service name.
string