Get Heatmap Transport Zone Status

Get Heatmap Transport Zone Status

Get high-level summary of a transport zone

Request
URI
GET
https://nsxmanager.your.domain/api/v1/transport-zones/{zone-id}/status
COPY
Path Parameters
string
zone-id
Required

ID of transport zone

Query Parameters
string
source
Optional

Data source type.

Possible values are : realtime, cached,
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns HeatMapTransportZoneStatus of type(s) application/json 
{
    "degraded_count": 0,
    "down_count": 0,
    "unknown_count": 0,
    "up_count": 0
}
integer As int32 As int32
degraded_count
Optional

Number of transport nodes that are degraded

integer As int32 As int32
down_count
Optional

Number of transport nodes that are down

integer As int32 As int32
unknown_count
Optional

Number of transport nodes with unknown status

integer As int32 As int32
up_count
Optional

Number of transport nodes that are up


400
Returns BadRequest of type(s) application/json 
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


403
Returns Forbidden of type(s) application/json 
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


404
Returns NotFound of type(s) application/json 
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


412
Returns PreconditionFailed of type(s) application/json 
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


500
Returns InternalServerError of type(s) application/json 
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


503
Returns ServiceUnavailable of type(s) application/json 
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


On This Page
Troubleshooting And Monitoring Operations
POST
Create Packet Capture Session
POST
Create Port Mirroring Sessions
POST
Create Traceflow
POST
Delete All Capture Sessions Delete
POST
Delete Packet Capture Session Delete
DELETE
Delete Port Mirroring Session
DELETE
Delete Traceflow
GET
Get All Transport Nodes Status
GET
Get All Transport Zone Status
GET
Get Forwarding Path
GET
Get Heatmap Transport Zone Status
GET
Get Ipfix Obs Points
GET
Get Pnic Statuses For Transport Node
GET
Get Port Mirroring Session
GET
Get Switch Ipfix Config
GET
Get Traceflow
GET
Get Traceflow Observations
GET
Get Transport Node Report
GET
Get Transport Node Report For A Transport Zone
GET
Get Transport Node Status
GET
List Node Logs
GET
List Packet Capture Sessions
GET
List Port Mirroring Session
GET
List Remote Transport Node Status
GET
List Traceflows
GET
List Transport Node Status
GET
List Transport Node Status For Transport Zone
GET
Read Node Log
GET
Read Node Log Data
GET
Read Packet Capture Session
POST
Terminate Packet Capture Session Terminate
PUT
Update Port Mirroring Session
PUT
Update Switch Ipfix Config
POST
Verify Port Mirroring Session Verify