[{"label":"Latest (v1.0)","version":"latest"}]
nsx-intelligence-&-application-platform

Get Resource Metric Meta Data

Description

Get metadata about metrics available for a resource type.

Request

Request

URL

URL


get
https://api_host/napp/api/v1/metrics/key-info
Copy

Query Parameters

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).


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns MetricsMetadataInfoList of type(s) application/json
{
	"results": [
		{
			"aggregate_by_resource_ids": false,
			"description": "string",
			"key": "string",
			"unit": "METRIC_COUNT",
			"value_type": "DOUBLE"
		}
	]
}
results Optional

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

Errors

Errors

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).

Code Samples

Code Samples

cURL Command

curl https://api_host/napp/api/v1/metrics/key-info?resource_type=string


[{"label":"Latest (v1.0)","version":"latest"}]
nsx-intelligence-&-application-platform
Feedback

Was this page helpful?