List Transport Node Status For Transport Zone

List Transport Node Status For Transport Zone

Read status of transport nodes in a transport zone

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

ID of transport zone

Query Parameters
string
cursor
Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

string
included_fields
Optional

Comma separated list of fields that should be included in query result

integer
page_size
Optional

Maximum number of results to return in this page (server may return fewer)

boolean
sort_ascending
Optional

sort_ascending

string
sort_by
Optional

Field by which records are sorted

string
source
Optional

Data source type.

Possible values are : realtime, cached,
string
status
Optional

Transport node

Possible values are : UP, DOWN, DEGRADED, UNKNOWN,

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns TransportNodeStatusListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineTransportNodeStatusListResult1
{
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "cursor": "string",
    "sort_ascending": false,
    "sort_by": "string",
    "result_count": 0,
    "results": [
        {
            "status": "string",
            "node_uuid": "string",
            "mgmt_connection_status": "string",
            "control_connection_status": {
                "status": "string",
                "degraded_count": 0,
                "down_count": 0,
                "up_count": 0
            },
            "pnic_status": {
                "status": "string",
                "degraded_count": 0,
                "down_count": 0,
                "up_count": 0
            },
            "node_display_name": "string",
            "tunnel_status": {
                "bfd_diagnostic": {
                    "concatenated_path_down_count": 0,
                    "administratively_down_count": 0,
                    "no_diagnostic_count": 0,
                    "path_down_count": 0,
                    "reverse_concatenated_path_down_count": 0,
                    "neighbor_signaled_session_down_count": 0,
                    "control_detection_time_expired_count": 0,
                    "echo_function_failed_count": 0,
                    "forwarding_plane_reset_count": 0
                },
                "bfd_status": {
                    "bfd_admin_down_count": 0,
                    "bfd_up_count": 0,
                    "bfd_down_count": 0,
                    "bfd_init_count": 0
                }
            }
        }
    ]
}

400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

404
Returns NotFound of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

412
Returns PreconditionFailed of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}