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

Get Metrics Data

Description

Get time series data points for a given resource type and resource identifiers.

Request

Request

URL

URL


post
https://api_host/napp/api/v1/metrics/data
Copy

Request Body

Request Body

MetricsDataRequest of type(s) application/json Optional

Metrics data request body, contains list of NSX Resource Intent Paths or UUIDS (for NSX objects without intents), resource type, time interval etc.

This request body class requires all of the following: MetricsBaseTimeRequest, InlineMetricsDataRequest1
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns MetricsDataResponse of type(s) application/json
{
	"end_time": 0,
	"granularity": "FIVE_MINUTES",
	"resource_type": "string",
	"results": [
		{
			"key_results": [
				{
					"description": "string",
					"key": "string",
					"results": [
						{
							"data": [
								{
									"time": 0,
									"value": "string"
								}
							],
							"node_id": "string",
							"node_name": "string",
							"node_path": "string",
							"object_id": "string"
						}
					],
					"unit": "METRIC_COUNT"
				}
			],
			"resource_id": "string",
			"resource_ref_id": "string"
		}
	],
	"start_time": 0
}
integer as int64
end_time Optional

Epoch time in seconds. Actual end time of the data being reported


granularity Optional

Enumeration of different granular data points supported by the system. Metrics data points are maintained at 5Mins, 1Hour and 1Day granularities.

Possible values are: FIVE_MINUTESONE_HOURONE_DAY


string
resource_type Optional

Resource Type for which metric data was requested for. E.g. PolicyEdgeNode


results Optional

Collection of per resource metric results


integer as int64
start_time Optional

Epoch time in seconds. Actual start time of the data being reported

Errors

Errors

400

Invalid Input

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{}' https://api_host/napp/api/v1/metrics/data


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

Was this page helpful?