System Administration >
Lifecycle Management
>
Upgrade
>
Status
Get functional state of the upgrade coordinator
Get the functional state of the upgrade coordinator.
Request:
Method:
GET
URI Path(s):
/api/v1/upgrade/functional-state
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a
Example Request:
GET https://<nsx-mgr>/api/v1/upgrade/functional-state
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
UcFunctionalState
+
UcFunctionalState
(
schema
)
Name
Description
Type
Notes
error_message
error message
error message that explains why UC is on standby mode.
string
Readonly
state
State of UC UI
function state of the upgrade coordinator
string
Required
Readonly
Enum: RUNNING, STANDBY
Example Response:
{ "state" : "RUNNING" }
Required Permissions:
read
Feature:
utilities_upgrade
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable