NSX-T Data Center REST API

MetricItem (type)

{
  "description": "This type represents the value of a metric and related information.",
  "id": "MetricItem",
  "module_id": "SystemHealth",
  "properties": {
    "degraded_threshold": {
      "description": "The threshold for determining the status as DEGRADED.",
      "required": false,
      "title": "Degraded threshold",
      "type": "number"
    },
    "down_threshold": {
      "description": "The threshold for determining the status as DOWN.",
      "required": false,
      "title": "Down threshold",
      "type": "number"
    },
    "error_message": {
      "description": "If metric status is not UP, this field show its possible reason.",
      "required": false,
      "title": "error message",
      "type": "string"
    },
    "metric_data_type": {
      "description": "Metric value data type, including STRING, INTEGER, FLOAT and BOOLEAN.",
      "enum": [
        "STRING",
        "INTEGER",
        "FLOAT",
        "BOOLEAN"
      ],
      "required": false,
      "title": "Metric data type",
      "type": "string"
    },
    "metric_description": {
      "description": "If the metric name cannot intuitively express the information of the metric, a detailed description is required here.",
      "required": false,
      "title": "Metric description",
      "type": "string"
    },
    "metric_id": {
      "description": "The unique id assigned to the metric name.",
      "title": "Metric ID",
      "type": "int"
    },
    "metric_name": {
      "description": "Name of the Metric. It acts as the 'key' to access the metric.",
      "title": "Metric name",
      "type": "string"
    },
    "metric_value_counter": {
      "description": "Metric original value for COUNTER type.",
      "required": false,
      "title": "Counter metric value",
      "type": "integer"
    },
    "metric_value_gauge": {
      "description": "Metric original value for GAUGE type.",
      "required": false,
      "title": "Gauge metric value",
      "type": "number"
    },
    "metric_value_histogram": {
      "$ref": "HistogramMetricValue",
      "description": "Metric original value for HISTOGRAM type.",
      "required": false,
      "title": "Histogram metric value"
    },
    "metric_value_string": {
      "description": "Metric original value for STRING type.",
      "required": false,
      "title": "String metric value",
      "type": "string"
    },
    "metric_value_vector": {
      "description": "Metric original value for VECTOR type.",
      "items": {
        "type": "number"
      },
      "required": false,
      "title": "Vector metric value",
      "type": "array"
    },
    "status": {
      "description": "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].",
      "enum": [
        "UP",
        "DOWN",
        "DEGRADED",
        "UNKNOWN",
        "STABLE",
        "UNAVAILABLE"
      ],
      "required": false,
      "title": "Status value",
      "type": "string"
    },
    "tags": {
      "description": "The tags of this metric.",
      "items": {
        "$ref": "MetricTag"
      },
      "required": false,
      "title": "Metric tags",
      "type": "array"
    }
  },
  "title": "Metric item",
  "type": "object"
}