This API has a deprecated equivalent from v7.0U1.
Cancel Restore Job
Cancel the restore job
Request
URLURL
https://{api_host}/api/appliance/recovery/restore/job?action=cancel
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
RecoveryRestoreJobReturnResult
of type application/json
RestoreJobStatus Structure
{
"messages": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string"
}
],
"status": "FAIL"
}
status
Required
Job.ReturnStatus enumerated type Defines the state of precheck
FAIL : Check failed
WARNING : Passed with warnings
OK : Check passed
Possible values are: FAIL , WARNING , OK
Errors
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-CancelRestoreJob
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/recovery/restore/job?action=cancel
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/appliance/recovery/restore/job/cancel
x-vmw-doc-operation: cancel
Availability
Added in 7.0U2
