REST API - get

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

Representation:

{
    "value" : {
        "start_time" : "2015-01-01T22:13:05.651Z",
        "end_time" : "2015-01-01T22:13:05.651Z",
        "messages" : [
            {
                "args" : [
                    "string",
                    "string"
                ],
                "default_message" : "string",
                "id" : "string"
            },
            {
                "args" : [
                    "string",
                    "string"
                ],
                "default_message" : "string",
                "id" : "string"
            }
        ],
        "progress" : 1,
        "id" : "string",
        "state" : "FAILED"
    }
}

Response Type:

Name	Type	Description
bold = required
value	backup_job_status	BackupJobStatus Structure.
value.id	string	TimeStamp based ID.
value.state	string	The state of the backup job. Defines the possible states of a backup/restore process. Value is one of: FAILED: Backup/Restore job failed. INPROGRESS: Backup/Restore job is in progress. NONE: Backup/Restore job is not started. SUCCEEDED: Backup/Restore job 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	Progress of the job in percentage.
value.start_time	date_time	Time when the backup was started.
value.end_time	date_time	Time when the backup was finished. Optional. If unset end time is None until backup is finished.

Errors:

HTTP Status Code	Type	Description
404	not_found	if backup associated with id does not exist.
500	error	if any error occurs during the execution of the operation.