[{"label":"Latest (v1.0)","version":"latest"}]
nsx-intelligence-and-application-platform

Get Object Info

Description

Get Info about reported objects corresponding to an entity and metric key

Request

Request

URL

URL


post
https://api_host/napp/api/v1/metrics/object-info
Copy

Request Body

Request Body

ObjectInfoRequest of type(s) application/json Optional

Object info request. Resource Id and metric key for which data is being requested.

This request body class requires all of the following: MetricsBaseTimeRequest, InlineObjectInfoRequest1
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns ObjectInfoResponse of type(s) application/json
{
	"end_time": 0,
	"granularity": "FIVE_MINUTES",
	"resource_type": "string",
	"results": [
		{
			"key_results": [
				{
					"key": "string",
					"object_results": [
						{
							"node_id": "string",
							"node_name": "string",
							"node_path": "string",
							"object_description": "string",
							"object_id": "string"
						}
					]
				}
			],
			"resource_id": "string"
		}
	],
	"start_time": 0
}
integer 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_MINUTESONE_HOURONE_DAY


string
resource_type Optional

NSX Resource type


results Optional

Collection of per resource entity and metric key object results


integer as int64
start_time Optional

Epoch time in seconds. Actual start time of the data being reported

Errors

Errors

400

Invalid Input was provided for this request. Please check the API documentation.

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{}' https://api_host/napp/api/v1/metrics/object-info


[{"label":"Latest (v1.0)","version":"latest"}]
nsx-intelligence-and-application-platform
Feedback

Was this page helpful?