System Administration > Configuration > Fabric > Edge Clusters > Edge Clusters

Get the Realized State of a Edge Cluster

Return realized state information of a edge cluster.
Any configuration update that affects the edge cluster can use this API
to get its realized state by passing a request_id returned by the
configuration change operation. e.g. Update configuration of edge cluster.

Request:

Method:
GET
URI Path(s):
/api/v1/edge-clusters/{edge-cluster-id}/state
Request Headers:
n/a
Query Parameters:
RealizationStateQueryParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/edge-clusters/bf8d4daf-93f6-4c23-af38-63f6d372e14e/state

Successful Response:

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

Example Response:

{ "details": [ { "sub_system_type": "TransportNode", "sub_system_id": "fe651e63-04bd-43a4-a8ec-45381a3b71b9", "state": "in_progress", "failure_message": "CCP Id:ab5958df-d98a-468e-a72b-d89dcdae5346, Message:State realization is in progress at the node." }, { "sub_system_type": "TransportNode", "sub_system_id": "ebe174ac-e4f1-4135-ba72-3dd2eb7099e3", "state": "in_sync" } ], "state": "in_progress", "failure_message": "The state realization is in progress at transport nodes." }

Required Permissions:

read

Feature:

nodes_edge_clusters

Additional Errors: