InlineMetricsPointInTimeExportRequest1

Additional properties specific to point-in-time export requests.

JSON Example

{
    "keys": [
        "string"
    ],
    "resource_types": [
        "string"
    ],
    "resource_ids": [
        "string"
    ],
    "filters": [
        {
            "filter_field": "string",
            "filter_operation": "string",
            "value": "string"
        }
    ],
    "sort_by": "string",
    "sort_ascending": false,
    "aggregation": {
        "aggregation_dimension": "string",
        "aggregation_function": "string"
    }
}

array of string

keys

Required

Constraints: minItems: 1 maxItems: 10

keys

array of string

resource_types

Required

Constraints: minItems: 1 maxItems: 1

This is a required field. Resource Type for which metric keys and their information is requested for. Examples of supported NSX resource types are PolicyEdgeNode, HostTransportNode, Tier0Interface, Tier1Interface, Tier0, Tier1, Rule, SegmentPort. Examples of supported (Security Services Platform) resource_types are SspCluster, SspNode and various SSP Services.

array of string

resource_ids

Required

List of all the resource IDs within the resource type. This can be the 'id' or 'path' field on the NSX API output, or it can be '*' if fetching Top N values is needed. For example, '/infra/tier-0s/tier0-providerA' or '/cluster'.

array of FilterComponent

filters

Optional

List of filters to be applied to search

Fields

sort_by

Optional

Constraints: default: METRIC_VALUE

The field options to filtering and sorting.

Enumeration: SITE_ID, NODE_ID, OBJ_ID, METRIC_VALUE, TIMESTAMP

boolean

sort_ascending

Optional

Whether to sort in ascending order or not

Aggregation

aggregation

Optional

Point-in-time aggregation object. Aggregates metrics across various dimensions.

Used By

MetricsPointInTimeExportRequest