NSX-T Data Center REST API

MetricMetadata (type)

{
  "description": "The health metrics metadata.",
  "id": "MetricMetadata",
  "module_id": "SystemHealthMetadata",
  "properties": {
    "is_status": {
      "default": false,
      "description": "Indicate if this metric is status type.",
      "title": "Is status",
      "type": "boolean"
    },
    "metric_data_type": {
      "description": "The data type of the health metric.",
      "enum": [
        "STRING",
        "INTEGER",
        "FLOAT",
        "BOOLEAN"
      ],
      "title": "Metric data type",
      "type": "string"
    },
    "metric_description": {
      "description": "The description of the health metric.",
      "title": "Metric description",
      "type": "string"
    },
    "metric_errors": {
      "description": "The errors of the health metric.",
      "items": {
        "$ref": "MetricError"
      },
      "title": "Metric errors",
      "type": "array"
    },
    "metric_id": {
      "description": "The unique id of the health metric.",
      "title": "Metric ID",
      "type": "int"
    },
    "metric_kblink": {
      "description": "If the metric is not health, the kb link could provide recommendations.",
      "title": "Metric kb link",
      "type": "string"
    },
    "metric_name": {
      "description": "The name of the health metric.",
      "title": "Metric name",
      "type": "string"
    },
    "metric_tags": {
      "description": "The tag name list of the health metric.",
      "items": {
        "type": "string"
      },
      "title": "Metric tags",
      "type": "array"
    },
    "metric_unit": {
      "description": "The unit of the health metric.",
      "enum": [
        "BYTES",
        "KILOBYTES",
        "MEGABYTES",
        "MILLISECOND",
        "MICROSECOND",
        "PERCENTAGE"
      ],
      "title": "Metric unit",
      "type": "string"
    },
    "metric_value_type": {
      "description": "The value type of the health metric.",
      "enum": [
        "STRING",
        "HISTOGRAM",
        "COUNTER",
        "GAUGE"
      ],
      "title": "Metric value type",
      "type": "string"
    },
    "repeatable_metric": {
      "default": false,
      "description": "Indicate if this metric has multiple instances with different tags.",
      "title": "Metric repeatable",
      "type": "boolean"
    },
    "service_name": {
      "description": "If the metric is service level, it shows the service name.",
      "title": "Service name",
      "type": "string"
    }
  },
  "title": "Metric metadata",
  "type": "object"
}