Management Plane API >
Networking
>
Logical Routing And Services
>
Logical Routers
Get the status for the Logical Router of the given id
Returns status for the Logical Router of the given id.
Request:
Method:
GET
URI Path(s):
/api/v1/logical-routers/<logical-router-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/logical-routers/875381be-a4c5-4173-8aa7-ab71695a8129/status
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
LogicalRouterStatus
+
LogicalRouterStatus
(
schema
)
Name
Description
Type
Notes
last_update_timestamp
Timestamp when the data was last updated; unset if data source has never updated the data.
EpochMsTimestamp
Readonly
locale_operation_mode
Location mode for logical router
Egress mode for the logical router at given mode
string
Readonly
Enum: PRIMARY_LOCATION, SECONDARY_LOCATION
logical_router_id
The id of the logical router
string
Required
per_node_status
Per Node Status
array of
LogicalRouterStatusPerNode
Readonly
Example Response:
{ "logical_router_id": "875381be-a4c5-4173-8aa7-ab71695a8129", "last_update_timestamp": 1457127071089, "per_node_status": [ { "service_router_id": "56eead22-3bb9-4586-8de3-9412941f9116", "high_availability_status": "STANDBY", "transport_node_id": "ca6fd559-198d-4a4a-a5be-7e4eda1d5af4" }, { "service_router_id": "56eead22-3bb9-4586-8de3-9412941f9116", "high_availability_status": "ACTIVE", "transport_node_id": "88324389-7991-4189-a4e9-3eaea4b97f61" } ] }
Required Permissions:
read
Feature:
routing_routers
Additional Errors:
404 Not Found
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable