System Administration >
Configuration
>
NSX Managers
>
Clusters
>
Cluster Status
Read Cluster Status
Returns status information for the NSX cluster control role and management
role.
Request:
Method:
GET
URI Path(s):
/api/v1/cluster/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a
Example Request:
GET https://<nsx-mgr>/api/v1/cluster/status
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterStatus
+
ClusterStatus
(
schema
)
Name
Description
Type
Notes
cluster_id
Unique identifier of this cluster
string
Readonly
control_cluster_status
The current status of the control cluster
ControllerClusterStatus
Readonly
detailed_cluster_status
Status of all the cluster groups
AllClusterGroupStatus
Readonly
mgmt_cluster_status
The current status of the management cluster
ManagementClusterStatus
Readonly
Example Response:
{ "control_cluster_status": { "status": "STABLE" }, "mgmt_cluster_status": { "online_nodes": [ { "mgmt_cluster_listen_ip_address": "192.168.110.31", "uuid": "42311EA1-D13F-C347-A2E4-7821B20F31BE" } ], "status": "STABLE" } }
Required Permissions:
read
Feature:
cluster_management
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable