Get Metrics Data
Get time series data points for a given resource type and resource identifiers.
Request
URI
POST
https://{api_host}/napp/api/v1/metrics/data
COPY
Request Body
Metrics data request body, contains list of NSX Resource Intent Paths or UUIDS (for NSX objects without intents), resource type, time interval etc.
MetricsDataRequest
of type(s)
application/json
Optional
This request body class requires all of the following:
InlineMetricsDataRequest0
,
InlineMetricsDataRequest1
{
"granularity": "string",
"start_time": 0,
"end_time": 0,
"resource_type": "string",
"resource_ids": [
"string"
],
"aggregate_resource_ids": false,
"aggregate_operation": "string",
"max_num_data_points": 0,
"keys": [
"string"
],
"object_ids": [
"string"
],
"node_ids": [
"string"
],
"empty_value_config": {
"technique": "string"
}
}Responses
200
OK
Returns
MetricsDataResponse
of type(s)
application/json
"MetricsDataResponse Object"
integer As int64
As int64
start_time
Optional
Epoch time in seconds. Actual start time of the data being reported
integer As int64
As int64
end_time
Optional
Epoch time in seconds. Actual end time of the data being reported
string
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_MINUTES,
ONE_HOUR,
ONE_DAY,
string
resource_type
Optional
Resource Type for which metric data was requested for. E.g. PolicyEdgeNode
array of
object
results
Optional
Collection of per resource metric results
400
Invalid Input
Operation doesn't return any data structure
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"keys":["string"],"resource_type:"string","resource_ids":["string"]}' https://{api_host}/napp/api/v1/metrics/data