NSX-T Data Center REST API

Get high-level summary of all transport nodes. The service layer does not support source = realtime or cached.

Request:

Method:

GET

URI Path(s):

/api/v1/transport-nodes/status

Request Headers:

n/a

Query Parameters:

TransportNodeFilter+

TransportNodeFilter (schema)

Name	Description	Type	Notes
node_type	Transport node type Transport node type	string	Enum: HOST, EDGE

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/transport-nodes/status

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

HeatMapTransportZoneStatus+

HeatMapTransportZoneStatus (schema)

Name	Description	Type	Notes
degraded_count	Number of transport nodes that are degraded	int
down_count	Number of transport nodes that are down	int
unknown_count	Number of transport nodes with unknown status	int
up_count	Number of transport nodes that are up	int

Example Response:

{ "down_count": 0, "unknown_count": 2, "up_count": 0, "degraded_count": 0 }

Required Permissions:

read

Feature:

nodes_transport_nodes

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable