System Administration >
Configuration
>
Fabric
>
Transport Zones
Get high-level summary of a transport zone
Request:
Method:
GET
URI Path(s):
/api/v1/transport-zones/{zone-id}/status
Request Headers:
n/a
Query Parameters:
DataSourceParameters
+
DataSourceParameters
(
schema
)
Name
Description
Type
Notes
source
The data source, either realtime or cached. If not provided, cached data is returned.
DataSourceType
Request Body:
n/a
Example Request:
GET https://<nsx-mgr>/api/v1/transport-zones/37b481c8-dd1e-4e17-bb2b-f922f1addaa8/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:
tools_heatmap
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