Get Metric Keys Information Per Resource Type

Get Metric Keys Information Per Resource Type

Get information like description, unit, value_type, metric_type about the metric keys available for a resource type.

Request
URI
GET
https://{api_host}/napp/api/v1/metrics/key-info
COPY
Query Parameters
string
resource_type
Required

Resource Type for which metric keys and their information is requested for. 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).

string
metric_key_type
Optional

The Metric key type to be returned. Allowed values are POINT_IN_TIME, TIME_SERIES and STATUS_METRIC. This will help filter the metric_keys which can be queried using in point-in-time API /napp/api/v1/metrics/point-in-time/data and time-series API /napp/api/v1/metrics/data.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns MetricsMetadataInfoList of type(s) application/json 
{
    "results": [
        {
            "description": "string",
            "key": "string",
            "unit": "string",
            "aggregate_by_resource_ids": false,
            "value_type": "string",
            "is_point_in_time": false,
            "is_time_series": false,
            "is_status_metric": false,
            "introduced_in_version": "string",
            "deprecated_in_version": "string"
        }
    ]
}
array of object
results
Optional

Results array where each entry in the array is of type MetricKeyMetadataInfo.


400

Invalid Input was provided to this request. Please ensure resource_type is provided and is a valid value. 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).

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -H 'Authorization: <value>' https://{api_host}/napp/api/v1/metrics/key-info?resource_type=v
On This Page
Metrics Operations
GET
Get Metric Keys Information Per Resource Type
POST
Get Time Series Data
POST
Get Point In Time Data
POST
Get Object Information
GET
Get Metrics Data Collection