[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api

Get Metrics

Description

Get metric points for an entity for an entity id and metric for a given time interval. Maximum number of metrics point returned by API is 300. In case the interval and time period combination have more than 300 metrics points, client should break the time period to multiple batches to get all the metrics points. These metric points are the points inside the metric charts (CPU, network rate, etc.)

Request

Request

URL

URL


get
https://vrni.example.com/api/ni/metrics
Copy

Query Parameters

Query Parameters

integer
end Required

end time for query in epoch seconds


string
entity_id Required

entity type


integer
interval Required

metric points interval


string
metric Required

metric name


integer
start Required

start time for query in epoch seconds


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns MetricResponse of type(s) application/json
{
	"display_name": "string",
	"end": 0,
	"interval": 0,
	"metric": "string",
	"pointlist": [
		0
	],
	"start": 0,
	"unit": "string"
}
string
display_name Optional

integer as int64
end Optional

integer
interval Optional

string
metric Optional

array of number as double
pointlist Optional

integer as int64
start Optional

string
unit Optional
Errors

Errors

400

Bad Request


401

Unauthorized


500

Internal Error

Code Samples

Code Samples

cURL Command

curl https://vrni.example.com/api/ni/metrics?end=10&entity_id=string&interval=10&metric=string&start=10


[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
Feedback

Was this page helpful?