Get Object Information
Get information about reported objects corresponding to a resource_type, resource_ids and metric keys. Use this to filter out the data points on time-series or point-in-time APIs as needed
Request
URI
POST
https://api_host/napp/api/v1/metrics/object-info
COPY
Request Body
Object info request. Resource Id and metric key for which data is being requested.
ObjectInfoRequest of type(s) application/json
Required
This request body class requires all of the following: MetricsBaseTimeRequest , InlineObjectInfoRequest1
Show optional properties
{
"resource_type": "string",
"resource_ids": [
"string"
],
"keys": [
"string"
]
}{
"granularity": "string",
"start_time": 0,
"end_time": 0,
"resource_type": "string",
"resource_ids": [
"string"
],
"keys": [
"string"
],
"site_ids": [
"string"
]
}
Responses
200
OK
Returns ObjectInfoResponse of type(s) application/json
{
"start_time": 0,
"end_time": 0,
"granularity": "string",
"resource_type": "string",
"results": [
{
"resource_id": "string",
"site_id": "string",
"key_results": [
{
"key": "string",
"object_results": [
{
"object_id": "string",
"object_description": "string",
"node_id": "string",
"node_path": "string",
"node_name": "string"
}
]
}
]
}
]
}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
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
NSX Resource type
array of ObjectInfoResourceResultEntry
results
Optional
Collection of per resource entity and metric key object results
400
Invalid Input was provided for this request. Please check the API documentation.
Operation doesn't return any data structure