Get Backup Job
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
See backup job progress/result.
Request
URLURL
https://{api_host}/rest/appliance/recovery/backup/job/{id}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | ID (ID of job) The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.job. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Response
Response
Response BodyResponse Body
200 OK returns
RecoveryBackupJobGetResponseBody
of type application/json
BackupJobStatus Structure
{
"value": {
"end_time": "string",
"id": "string",
"messages": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string"
}
],
"progress": 0,
"start_time": "string",
"state": "enum"
}
}| Property Name | Type | Description |
|---|---|---|
| value | RecoveryBackupJobBackupJobStatus |
BackupJobStatus Structure |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/appliance/recovery/backup/job/{id}
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | ErrorRest | com.vmware.vapi.std.errors.not_found : if backup associated with id does not exist. | com.vmware.vapi.std.errors.error : if any error occurs during the execution of the operation. |
| default | ErrorRest | Not available |
