InlineMetricsDataRequest1

InlineMetricsDataRequest1

JSON Example

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

array of string

keys

Required

Constraints: maxItems: 5

List of metric keys for which data is queried for. This is a required field. Use /key-info API to see which metric keys are supported for a given resource_type.

string

resource_type

Required

NSX Resource type for which metrics is queried for. This is a required field. Examples of few of the Supported NSX resource types are PolicyEdgeNode, ClusterNode, Tier0Interface, Tier1Interface, Tier0, Tier1. Refer to the 'resource_type' on NSX API output. Supported SSP (Security Services Platform) resource_types are SspCluster (Kubernetes cluster level) and SspNode (Kubernetes worker level).

array of string

resource_ids

Required

Constraints: maxItems: 5

List of NSX resource ids for which metrics data is being queried for. This can be 'id' or 'path' field on the NSX API output. E.g '/infra/tier-0s/tier0-providerA' or '/cluster'. 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 '/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

Constraints: default: AVG

Aggregation operation to be performed on the data points being queried for. This is valid only when aggregate_resource_ids is set to 'true'. Aggregation operation does not apply for 'status' metrics.

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

integer

max_num_data_points

Optional

Constraints: maximum: 600

Number of distinct metrics data points to return. Distinct metric is defined by combination of resource_type + site_id + node_id + resource_id + obj_id + metric_key

array of string

object_ids

Optional

Constraints: maxItems: 25

Optional Input list of object ids to get a filtered list of metrics for select object_ids.

array of string

node_ids

Optional

Constraints: maxItems: 1

Optional Input list of node ids to get a filtered list of metrics for select node_ids.

array of string

site_ids

Optional

Constraints: maxItems: 5

Optional Input list of site ids for which metrics data is being queried for.

Used By

MetricsDataRequest