NSX-T Data Center REST API

Read health metrics of all the virtual network appliance nodes (Experimental)

Return results in paginated form.

Method:

GET

URI Path(s):

/api/v1/systemhealth-extended/virtual-network-appliance-nodes

Request Headers:

n/a

Query Parameters:

TransportNodeHealthParameters+

Name	Description	Type	Notes
compact_mode	Enable compact response mode This parameter is used to decide whether the caller needs more compact response body. If it is absent or the value is false, the response will contain full information. Otherwise, it means the response just provides necessary runtime information and avoid duplicating description information which is already provided by corresponding metadata API.	boolean
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
node_id	The UUID of transport node This parameter is to filter the specific transport node. If not provide any node_id, it means query all transport node.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending	If true, results are sorted in ascending order	boolean
sort_by	Field by which records are sorted	string
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType

Request Body:

n/a

GET https://<nsx-mgr>/api/v1/systemhealth-extended/virtual-network-appliance-nodes

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

NodesMetricsList+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List of health metrics List of unified appliance or transport node health metrics.	array of NodeMetrics
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

read

cluster_management