This API has a deprecated equivalent from v7.0U1.
Get Restore Job
See restore job progress/result.
Request
URLURL
https://{api_host}/api/appliance/recovery/restore/job
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
RecoveryRestoreJobRestoreJobStatus
of type application/json
RestoreJobStatus Structure
{
"messages": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string"
}
],
"progress": 0,
"state": "FAILED"
}
integer
progress
Required
percentage complete
state
Required
Job.BackupRestoreProcessState enumerated type Defines state of backup/restore process
FAILED : Failed
INPROGRESS : In progress
NONE : Not started
SUCCEEDED : Completed successfully
Possible values are: FAILED , INPROGRESS , NONE , SUCCEEDED
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-GetRecoveryRestoreJob
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/recovery/restore/job
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/appliance/recovery/restore/job
x-vmw-doc-operation: get
Availability
Added in 7.0U2
