MetricKeyMetaDataInfo | NSX Application Platform Metrics API

MetricKeyMetaDataInfo

Metrics metadata info

JSON Example

{
    "description": "string",
    "key": "string",
    "unit": "string",
    "aggregate_by_resource_ids": false,
    "value_type": "string",
    "is_point_in_time": false,
    "is_time_series": false,
    "is_status_metric": false,
    "introduced_in_version": "string",
    "deprecated_in_version": "string"
}

string

description

Optional

Description about the metric key

string

key

Optional

Metric key identifier

MetricsUnit

unit

Optional

Metrics unit enum

Possible values are : METRIC_COUNT, BITS_PER_SECOND, PERCENT, MILLISECONDS, SECONDS, PER_SECOND, BYTES, KILO_BYTES, KILO_BYTES_PER_SECOND, BYTES_PER_SECOND, KILO_BITS_PER_SECOND, GIGA_BYTES, MEGA_BYTES, NORMALIZED, STRING, SEC, MIN, DAYS, KB, MB, GB, MBPS, GHZ, RATIO, MICROSECONDS, HEALTH, HOURS, PACKETS_PER_SECOND, PACKETS, NANOSECONDS,

boolean

aggregate_by_resource_ids

Optional

Flag to indicate if this metrics is aggregateable across all resource_ids using our Data API.

ValueType

value_type

Optional

Type for values

Possible values are : DOUBLE, STRING,

boolean

is_point_in_time

Optional

PointInTime metrics key flag. These keys can be queried using /napp/api/v1/metrics/point-in-time/data api.

boolean

is_time_series

Optional

Time series metrics key flag. These keys can be queried using /napp/api/v1/metrics/data api.

boolean

is_status_metric

Optional

Status metrics key flag. Query this metric using point-in-time url /napp/api/v1/metrics/point-in-time/data if only the latest status is of interest. Query using time-series url /napp/api/v1/metrics/data if the interest is to see the transitions of this status in a given time interval.

string

introduced_in_version

Optional

Release version in which this metric was introduced.

string

deprecated_in_version

Optional

Release version in which this metric was deprecated.

Property Of

MetricsMetadataInfoList