NSX-T Data Center REST API

Get VPC state

Get the VPC's runtime state that includes the gateway id and the HA details, if applicable.

Request:

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

Example Request:

GET https://<policy-mgr>/policy/api/v1/orgs/default/projects/project-2/vpcs/vpc-1/state

Successful Response:

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

Example Response:

{ "logical_gateway_id": "3d371765-e5e2-4a1d-aa95-7e38fefd1b36", "last_update_timestamp": 1713547923676, "per_node_status": [ { "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/8bd470cd-f932-4ec0-8836-910ddd9954ee/edge-nodes/1", "service_gateway_id": "650b3968-4794-47b4-b121-3f6e7d17282f", "high_availability_mode": "ACTIVE", }, { "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/8bd470cd-f932-4ec0-8836-910ddd9954ee/edge-nodes/0", "service_gateway_id": "650b3968-4794-47b4-b121-3f6e7d17282f", "high_availability_mode": "STANDBY", } ] }

Required Permissions:

read

Feature:

policy_vpc

Additional Errors: