NSX-T Data Center REST API

Get the status for the Edge cluster of the given id

Returns the aggregated status for the Edge cluster along with status of
all edge nodes in the cluster. Query parameter "source=realtime" is the
only supported source.

Request:

Method:

GET

URI Path(s):

/api/v1/edge-clusters/{edge-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

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

EdgeClusterStatus+

EdgeClusterStatus (schema)

Name	Description	Type	Notes
edge_cluster_id	Edge cluster id Id of the edge cluster whose status is being reported	string	Required
edge_cluster_status	Status of an edge node	string	Required Enum: UP, DOWN, DEGRADED, UNKNOWN
last_update_timestamp	Last updated timestamp Timestamp when the cluster status was last updated	EpochMsTimestamp	Required Readonly
member_status	Per Edge Node Status	array of EdgeClusterMemberStatus	Readonly

Example Response:

{ "edge_cluster_id": "875381be-a4c5-4173-8aa7-ab71695a8129", "member_status": [ { "transport_node_id": "56eead22-3bb9-4586-8de3-9412941f9116", "status": "UP" }, { "transport_node_id": "77eead22-3bb9-4586-8de3-9412941f9116", "status": "DOWN" } ], "last_update_timestamp": 1457117071089, "edge_cluster_status": "DEGRADED" }

Required Permissions:

read

Feature:

nodes_edge_clusters

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable