Management Plane API >
Networking
>
Logical Bridging
>
Bridge Clusters
Returns status of a specified Bridge Cluster
Get the status for the Bridge Cluster of the given cluster id
Request:
Method:
GET
URI Path(s):
/api/v1/bridge-clusters/<cluster-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/bridge-clusters/e9a02047-9bc8-4d05-ad73-8d5552f48306/status
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
BridgeClusterStatus
+
BridgeClusterStatus
(
schema
)
Name
Description
Type
Notes
cluster_id
The id of the cluster
string
Required
Readonly
health
The health status of the cluster
string
Required
Readonly
Enum: UP, DOWN, DEGRADED, UNKNOWN
last_update_timestamp
Timestamp when the data was last updated; unset if data source has never updated the data.
EpochMsTimestamp
Readonly
Example Response:
{ "cluster_id": "e9a02047-9bc8-4d05-ad73-8d5552f48306", "last_update_timestamp": 1457547628680, "health": "DOWN" }
Required Permissions:
read
Feature:
aggregation_service_health_monitoring
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