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
Object info request. Resource Id and metric key for which data is being requested.
{
"granularity": "string",
"start_time": 0,
"end_time": 0,
"resource_type": "string",
"resource_ids": [
"string"
],
"keys": [
"string"
],
"site_ids": [
"string"
]
}OK
{
"start_time": 0,
"end_time": 0,
"granularity": "string",
"resource_type": "string",
"results": [
{
"resource_id": "string",
"site_id": "string",
"display_name": "string",
"key_results": [
{
"key": "string",
"object_results": [
{
"object_id": "string",
"object_description": "string",
"node_id": "string",
"node_path": "string",
"node_name": "string"
}
]
}
]
}
]
}Epoch time in milliseconds. Actual start time of the data being reported
Epoch time in milliseconds. Actual end time of the data being reported
Granularity of the metrics data required. Defaults are based on below setting - -- If time-range is <= 12 hr, default to 5 min granularity. -- If time-range is > 12 hrs and <= 7 days, default to 1 hr granularity. -- If time-range is more than 7 days, default to 1 day granularity. If you are looking for more coarser value, use this field. E.g If ONE_HOUR is set, system will aggregate all the data points available within one hour and return the aggregated metric value. This field is not relevant (ignored) for "is_status" metrics.
This is a required field. Resource Type for which metric keys and their information is requested for. Example of support NSX resource types are PolicyEdgeNode, HostTransportNode, Tier0Interface, Tier1Interface, Tier0, Tier1, Rule, SegmentPort. Example of supported (Security Services Platform) resource_types are SspCluster, SspNode and various SSP Services.
Collection of per resource entity and metric key object results
Error Response
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code
Module where the error happened
Message describing the error
curl -X POST -H 'Content-Type: application/json' -d '{"keys":["string"],"resource_ids":["string"],"resource_type:"string"}' https://{api_host}/metrics/object-info