PointInTimeMetrics

Point In Time Metrics

All the latest collected metrics data object.

JSON Example

{
    "key": "string",
    "description": "string",
    "units": "string",
    "result_count_per_key": 0,
    "metrics_data": [
        {
            "obj_id": "string",
            "resource_id": "string",
            "resource_ref_id": "string",
            "node_id": "string",
            "site_id": "string",
            "display_name": "string",
            "timestamp": 0,
            "value": "string"
        }
    ],
    "aggregation_details": {
        "sites": 0,
        "nodes": 0,
        "resources": 0,
        "objects": 0
    },
    "tags": [
        {
            "name": "string",
            "value": "string"
        }
    ]
}

string

key

Optional

Metric key for which data is queried for. This is a required field.

string

description

Optional

Metric description for the metric key.

MetricsUnit

units

Optional

Unit of the metric, for example, PERCENT, BYTES, SEC, BYTES_PER_SEC.

Enumeration: 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

integer As int32 As int32

result_count_per_key

Read-Only

The total count of unique metrics found.

array of PointInTimeMetricsData

metrics_data

Optional

All the latest collected metrics data.

AggregationDetails

aggregation_details

Optional

The aggregation details specifying the span of the aggregation in terms of the number of sites, nodes, etc. Only returned when an aggregation is specified.

array of MetricTag