Cancel Cluster Restore

This operation is only valid when a restore is in suspended state. The UI user can cancel any restore operation when the restore is suspended either due to an error, or for a user input. The API user would need to monitor the progression of a restore by calling periodically "/api/v1/cluster/restore/status" API. The response object (ClusterRestoreStatus), contains a field "endpoints". The API user can cancel the restore process if 'cancel' action is shown in the endpoint field. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED.

Request

URI

POST

https://nsxmanager.your.domain/api/v1/cluster/restore?action=cancel

COPY

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns ClusterRestoreStatus of type(s) application/json

{
    "allowed_actions": [
        "string"
    ],
    "backup_timestamp": 0,
    "endpoints": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "id": "string",
    "instructions": [
        {
            "actions": [
                "string"
            ],
            "fields": [
                "string"
            ],
            "id": "string",
            "name": "string"
        }
    ],
    "not_allowed_actions": [
        "string"
    ],
    "restore_end_time": 0,
    "restore_start_time": 0,
    "status": {
        "description": "string",
        "value": "string"
    },
    "step": {
        "description": "string",
        "status": {
            "description": "string",
            "value": "string"
        },
        "step_number": 0,
        "value": "string"
    },
    "total_steps": 0
}

array of string

allowed_actions

Optional

Constraints: default:

List of actions that are allowed.

integer As int64 As int64

backup_timestamp

Optional

Timestamp when backup was initiated in epoch millisecond

array of object

endpoints

Optional

The list of allowed endpoints, based on the current state of the restore process

string

Optional

Unique id for backup request

array of object

instructions

Optional

Instructions for users to reconcile Restore operations

array of string

not_allowed_actions

Optional

Constraints: default:

List of actions that are not allowed

integer As int64 As int64

restore_end_time

Optional

Timestamp when restore was completed in epoch millisecond

integer As int64 As int64

restore_start_time

Optional

Timestamp when restore was started in epoch millisecond

object

status

Optional

Overall restore process status

object

step

Optional

Restore step info

integer As int64 As int64

total_steps

Optional

Total number of steps in the entire restore process

400

Returns BadRequest of type(s) application/json

Operation doesn't return any data structure

403

Returns Forbidden of type(s) application/json

Operation doesn't return any data structure

404

Returns NotFound of type(s) application/json

Operation doesn't return any data structure

409

Conflict

Returns ClusterRestoreStatus of type(s) application/json

"ClusterRestoreStatus Object"

array of string

allowed_actions

Optional

Constraints: default:

List of actions that are allowed.

integer As int64 As int64

backup_timestamp

Optional

Timestamp when backup was initiated in epoch millisecond

array of object

endpoints

Optional

The list of allowed endpoints, based on the current state of the restore process

string

Optional

Unique id for backup request

array of object

instructions

Optional

Instructions for users to reconcile Restore operations

array of string

not_allowed_actions

Optional

Constraints: default:

List of actions that are not allowed

integer As int64 As int64

restore_end_time

Optional

Timestamp when restore was completed in epoch millisecond

integer As int64 As int64

restore_start_time

Optional

Timestamp when restore was started in epoch millisecond

object

status

Optional

Overall restore process status

object

step

Optional

Restore step info

integer As int64 As int64

total_steps

Optional

Total number of steps in the entire restore process

412

Returns PreconditionFailed of type(s) application/json

Operation doesn't return any data structure

500

Returns InternalServerError of type(s) application/json

Operation doesn't return any data structure

503

Returns ServiceUnavailable of type(s) application/json

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' https://{api_host}/api/v1/cluster/restore?action=cancel

On This Page

Description

Request

Authentication

Response

200 Response Body

Errors

System Administration Operations