NSX-T Data Center REST API

Get Transit Gateway state

Get the transit gateway's runtime state that includes the transport node and the HA details, if applicable.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/state
Request Headers:
n/a
Query Parameters:
TransitGatewayStateRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/orgs/default/projects/project-2/transit-gateways/transit-gateway-1/state

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
TransitGatewayState+

Example Response:

{ "logical_gateway_id": "5e2add48-8ea3-47fa-a795-120aa178803e", "last_update_timestamp": 1714689267599, "per_node_status": [ { "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/8bd470cd-f932-4ec0-8836-910ddd9954ee/edge-nodes/0", "service_gateway_id": "caa24aad-4c69-4779-b62d-ecc3a07befde", "high_availability_status": "ACTIVE", "is_default_sub_cluster": false }, { "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/8bd470cd-f932-4ec0-8836-910ddd9954ee/edge-nodes/1", "service_gateway_id": "8c21518d-f515-492f-a709-581dee8cfcd5", "high_availability_status": "STANDBY", "is_default_sub_cluster": false } ] }

Required Permissions:

read

Feature:

policy_transit_gateway

Additional Errors: