Get Object Information

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}/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: InlineObjectInfoRequest0 , InlineObjectInfoRequest1 
{
    "granularity": "string",
    "start_time": 0,
    "end_time": 0,
    "resource_type": "string",
    "resource_ids": [
        "string"
    ],
    "keys": [
        "string"
    ],
    "site_ids": [
        "string"
    ]
}
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ObjectInfoResponse of type(s) application/json 
"ObjectInfoResponse 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

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.

Possible values are : FIVE_MINUTES, ONE_HOUR, ONE_DAY,
string
resource_type
Optional

NSX Resource type

array of object
results
Optional

Collection of per resource entity and metric key object results


default

Error Response

Returns Error of type(s) application/json 
"Error Object"
integer
error_code
Required

HTTP Status or Application error code

string
module_name
Optional

Module where the error happened

string
error_message
Required

Message describing the error


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"keys":["string"],"resource_ids":["string"],"resource_type:"string"}' https://{api_host}/metrics/object-info
On This Page
Metrics Operations
GET
Get Metric Keys Information Per Resource Type
POST
Get Time Series Data
POST
Get Point In Time Data
POST
Get Object Information