1. Operations
  2. appliance
  3. recovery
  4. backup
  5. job

appliance recovery backup job: get

See backup job progress/result.

Request:

HTTP request

GET https://{server}/rest/appliance/recovery/backup/job/{id}

Path Parameters

Name Type Description
Required
id string ID (ID of job).

Response:

HTTP Status Code: 200

Representations:

{
    "value": {
        "end_time": "2015-01-01T22:13:05.651Z",
        "id": "string",
        "messages": [
            {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            }
        ],
        "progress": 1,
        "start_time": "2015-01-01T22:13:05.651Z",
        "state": "FAILED"
    }
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/appliance/recovery/backup/job" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <progress>1</progress>
    <id>string</id>
    <end_time>2015-01-01T22:13:05.651Z</end_time>
    <state>FAILED</state>
    <start_time>2015-01-01T22:13:05.651Z</start_time>
    <messages-array>
      <array-item>
        <default_message>string</default_message>
        <id>string</id>
        <args-array>
          <array-item>string</array-item>
          <array-item>string</array-item>
        </args-array>
      </array-item>
      <array-item>
        <default_message>string</default_message>
        <id>string</id>
        <args-array>
          <array-item>string</array-item>
          <array-item>string</array-item>
        </args-array>
      </array-item>
    </messages-array>
  </value>
</ns0:Get-Result>

Response Type:

Name Type Description
bold = required
value backup_job_status BackupJobStatus Structure.
value.id string TimeStamp based ID
value.state string process state

Defines state of backup/restore process Value is one of:
FAILED: Failed
INPROGRESS: In progress
NONE: Not started
SUCCEEDED: Completed successfully
value.messages localizable_message[] list of messages
value.messages[].id string id in message bundle
value.messages[].default_message string text in english
value.messages[].args string[] nested data
value.progress long percentage complete
value.start_time date_time Time when this backup was started.
value.end_time date_time Time when this backup was finished.

Optional. endTime End time is None till backup is finished.

Errors:

HTTP Status Code Type Description
404 not_found ID is not found
500 error Generic error