System Administration >
Configuration
>
Site Management
Get the switchover status
Request:
Method:
GET
URI Path(s):
/api/v1/sites/switchover-status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a
Example Request:
GET https://<nsx-mgr>/api/v1/sites/switchover-status
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
SwitchoverStatus
+
SwitchoverStatus
(
schema
)
Name
Description
Type
Notes
current_step
Progress of each items
ProgressItem
current_step_number
Current number
integer
Required
note
Special messages, most of the time this will be empty, i.e. If SM performing the operation went down, another SM will restart the progress.
string
Required
number_of_steps
Total number of steps
integer
Required
overall_status
Status of the operation
string
Required
Enum: NOT_STARTED, RUNNING, ERROR, COMPLETE
Example Response:
{ "overall_status": "ERROR", "note": "", "current_step": { "name": "precheck", "description": "precheck", "parts": [ { "name": "precheck", "description": "precheck", "status": "ERROR", "percentage": 0, "error": "Some problem have occured" } ] }, "current_step_number", 1, "number_of_stemps", 6 }
Required Permissions:
read
Feature:
cluster_management
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
412 Precondition Failed
500 Internal Server Error
503 Service Unavailable