NSX-T Data Center REST API

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

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/transport-zones-aggstatus

Request Headers:

n/a

Query Parameters:

TransportZoneFilter+

TransportZoneFilter (schema)

Name	Description	Type	Notes
include_system_owned	Include system owned transport zones If true, system owned transport zones will be returned in API. Default false.	boolean

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/transport-zones-aggstatus

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

HeatMapTransportNodesAggregateStatus+

HeatMapTransportNodesAggregateStatus (schema)

Name	Description	Type	Notes
degraded_count	Degraded count Number of transport zones that are degraded.	int
down_count	Down count Number of transport zones that are down.	int
unknown_count	Unknown count Number of transport zones with unknown status.	int
unused_count	Unused count Number of transport zones with unused status.	int
up_count	Up count Number of transport zones that are up.	int

Example Response:

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

Required Permissions:

read

Feature:

transport_zones_transport_zones

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