InlineMetricsDataRequest1

JSON Example

{
    "resource_type": "string",
    "resource_ids": [
        "string"
    ],
    "aggregate_resource_ids": false,
    "aggregate_operation": "string",
    "max_num_data_points": 0,
    "keys": [
        "string"
    ],
    "object_ids": [
        "string"
    ],
    "node_ids": [
        "string"
    ],
    "empty_value_config": "EmptyValueConfiguration Object"
}

string

resource_type

Required

NSX Resource type for which metrics is queried for. This is a required field. Supported NSX resource types are PolicyEdgeNode, ClusterNode, Tier0Interface, Tier1Interface, Tier0, Tier1. Supported NAPP (NSX Kubernetes Application Platform) resource types are Napp (Kubernetes cluster level) and NappNode (Kubernetes worker level).

array of string

resource_ids

Required

Constraints: default: 1

Required parameter of input list of NSX resource ids for which metrics data is being queried for. If we want to fetch aggregate metrics across all resource_ids then "*" should be passed here and aggregate_resource_ids should be set true along with appropriate aggregate_operation should be provided. Please note not all metric keys support aggregation across resource_ids. Users should use '/metrics/key-info' API to check which keys have aggregate_by_resource_ids set to true. If resource_ids are UUID's as opposed to intent paths, make sure all the resource_ids are associated with the correct resource_type.

boolean

aggregate_resource_ids

Optional

When this is set to true we expect * to be passed for resource_ids field and the metrics values will be aggregated for all resources. The aggregate_operation must be specified when this flag is set to true.

MetricsAggregateOperation

aggregate_operation

Optional

Aggregation operation to be performed on the data points being queried for. e.g. SUM of data points or AVG of the datapoints.

Possible values are : AVG, SUM, MIN, MAX, PERCENT,

integer

max_num_data_points

Optional

Constraints: maximum: 600 default: 12

Number of data points to return

array of string

keys

Required

Constraints: maxItems: 5

List of metric keys for which data is queried for. This is required.

array of string

object_ids

Optional

Constraints: maxItems: 25

Optional Input list of object ids for which metrics data is being queried for. all entities matching all combinations of resource_ids[i]/node_ids[j]/object_ids[k] will be returned. If object ids are not provided and a metric is reported per object id, we will return per resource_id/object_id.

array of string

node_ids

Optional

Constraints: maxItems: 1

Optional Input list of node ids for which metrics data is being queried for. all entities matching all combinations of resource_ids[i]/node_ids[j]/object_ids[k] will be returned. If node ids are not provided and a metric value is stored per node_id, we will return value for <resourceId, nodeId>.

EmptyValueConfiguration

empty_value_config

Optional

Configuration specifying how to populate empty data points in a time-series metric response

Used By

MetricsDataRequest