NSX-T Data Center REST API

Cancel any running restore operation

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:

Method:
POST
URI Path(s):
/policy/api/v1/cluster/restore?action=cancel
/api/v1/cluster/restore?action=cancel
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request:

POST https://<nsx-mgr>/api/v1/cluster/restore?action=cancel

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterRestoreStatus+

Example Response:

{ "id": "86e81e05-bc3c-4216-a0a2-3bf46ece68a3", "backup_timestamp": 1435298084391, "restore_start_time": 1483463180963, "restore_end_time": null, "step": { "step_number": 1, "value": "RESTORE_INITIATED", "description": "Starting cluster restore" "status": { "value": "RUNNING", "description": "Cluster restore initiated" } }, "status": { "value": "SUSPENDING", "description": "A suspend request is being processed" } "total_steps": 11, "endpoints": [ { action: POST, href: '/cluster/restore?action=resume', rel: "self" }, { action: POST, href: '/cluster/restore?action=cancel', rel: "self" } ], "instructions": [] }

Required Permissions:

crud

Feature:

utilities_backup

Additional Errors: