REST API - get

vcenter nsx recovery: get

Returns whether recovery is needed. If needed, then returns the type of loss that needs recovery. If recovery is not needed, then clears the recovery state to allow the WCP service to enter steady state. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

POST https://{server}/api/vcenter/nsx/recovery

?action=get

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "loss""ALL",
    "needed"true
}

Headers:

None

Type:

Name Type Description
bold = required
- info Returns an Info.
-.needed boolean Indicates whether recovery needs to be performed. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.loss string Indicates the type of loss that needs recovery. If recovery is needed, then loss is present. If recovery is not needed, then loss is not present. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If unset, no loss occurred.

Errors:

HTTP Status Code Type Description
403 unauthorized if the user is not a member of the Administrators group.
401 unauthenticated if the user can not be authenticated.
500 internal_server_error if the type of recovery is invalid.
500 error for any other unspecified error.