InlinePointInTimeMetricsQuery0

InlinePointInTimeMetricsQuery0

JSON Example

{
    "resource_ids": [
        "string"
    ],
    "resource_types": [
        "string"
    ],
    "keys": [
        "string"
    ],
    "sort_by": "string",
    "sort_ascending": false,
    "page_number": 0,
    "page_size": 0,
    "filters": [
        "FilterComponent Object"
    ],
    "aggregation": "Aggregation Object"
}

array of string

resource_ids

Required

Constraints: maxItems: 5

List of all the resource ids within the resource type. This can be 'id' or 'path' field on the NSX API output or it can be '*' if need to fetch Top N values. E.g '/infra/tier-0s/tier0-providerA' or '/cluster'.

array of string

resource_types

Required

Constraints: minItems: 1 maxItems: 1

NSX Resource type for which metrics is queried for. This is a required field, restricted to one. 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

keys

Required

Constraints: minItems: 1 maxItems: 10

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

Fields

sort_by

Optional

Constraints: default: METRIC_VALUE

The field options to filtering and sorting.

Possible values are : SITE_ID, NODE_ID, OBJ_ID, METRIC_VALUE, TIMESTAMP,

boolean

sort_ascending

Optional

Whether to sort in ascending order or not

integer As int32 As int32

page_number

Optional

Constraints: minimum: 1 default: 1

Used along with the page size to fetch the desired set of records

integer As int32 As int32

page_size

Optional

Constraints: minimum: 1 maximum: 1000 default: 50

Maximum number of results to return in this page (server may return fewer)

array of FilterComponent

filters

Optional

List of filters to be applied to search

Aggregation

aggregation

Optional

Aggregate metrics across various dimensions

Used By

PointInTimeMetricsQuery