This API has a deprecated equivalent from v7.0U1.

List Backup Job Details

Identifiers of backup jobs that can match the filter. If unset the filter will match all the backup jobs. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.appliance.recovery.backup.job. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.appliance.recovery.backup.job.

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.

api_key

Response

Response Body

200 OK returns map of RecoveryBackupJobDetailsInfo of type application/json

Map of backup job identifier to Info Structure. The key in the result map will be an identifier for the resource type: com.vmware.appliance.recovery.backup.job.

{
	"build": {
		"build_number": "string",
		"version": "string",
		"version_name": "string"
	},
	"cancelable": false,
	"description": {
		"args": [
			"string"
		],
		"default_message": "string",
		"id": "string",
		"localized": "string",
		"params": {
			"key": {
				"d": 0,
				"dt": "string",
				"format": "SHORT_DATE",
				"i": 0,
				"l": {
					"id": "string",
					"params": "StdLocalizationParam Object"
				},
				"precision": 0,
				"s": "string"
			}
		}
	},
	"duration": 0,
	"end_time": "string",
	"error": {},
	"fast_backup": false,
	"location": "string",
	"location_user": "string",
	"messages": [
		{
			"args": [
				"string"
			],
			"default_message": "string",
			"id": "string",
			"localized": "string",
			"params": {
				"key": {
					"d": 0,
					"dt": "string",
					"format": "SHORT_DATE",
					"i": 0,
					"l": {
						"id": "string",
						"params": "StdLocalizationParam Object"
					},
					"precision": 0,
					"s": "string"
				}
			}
		}
	],
	"operation": "string",
	"parent": "string",
	"progress": {
		"completed": 0,
		"message": {
			"args": [
				"string"
			],
			"default_message": "string",
			"id": "string",
			"localized": "string",
			"params": {
				"key": {
					"d": 0,
					"dt": "string",
					"format": "SHORT_DATE",
					"i": 0,
					"l": {
						"id": "string",
						"params": "StdLocalizationParam Object"
					},
					"precision": 0,
					"s": "string"
				}
			}
		},
		"total": 0
	},
	"service": "string",
	"size": 0,
	"start_time": "string",
	"status": "enum",
	"target": {
		"id": "string",
		"type": "string"
	},
	"type": "SCHEDULED",
	"user": "string"
}

array of StdLocalizableMessage

messages Required

List of any info/warning/error messages returned by the backup job.

boolean

cancelable Required

Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.

StdLocalizableMessage

description Required

Description of the operation associated with the task.

RecoveryBackupJobDetailsType

type Required

The Details.Type enumerated type defines the type of backup job.
SCHEDULED : Job type is Scheduled.
MANUAL : Job type is Manual.

Possible values are: SCHEDULED , MANUAL

TaskStatus

status Required

Status of the operation associated with the task.

string

service Required

Identifier of the service containing the operation. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.service. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.service.

string

operation Required

Identifier of the operation associated with the task. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.operation. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.operation.

string

location Required

URL of the backup location.

string

location_user Required

The username for the remote backup location.

RecoveryBackupJobDetailsBuildInfo

build Optional

Information about the build of the appliance. This field is optional because it was added in a newer version than its parent node.

boolean

fast_backup Optional

Option to enable Postgres DB/ VCDB fast backup

string

parent Optional

Parent of the current task. This field will be unset if the task has no parent. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.cis.task. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.cis.task.

TaskProgress

progress Optional

Progress of the job. This field is optional and it is only relevant when the value of CommonInfo#status is one of SUCCEEDED, FAILED, or RUNNING.

object

error Optional

Description of the error if the operation status is “FAILED”. If unset the description of why the operation failed will be included in the result of the operation (see Info.result).

integer

size Optional

Size of the backup data transferred to remote location. This field is optional and it is only relevant when the value of CommonInfo#status is one of SUCCEEDED, FAILED, or RUNNING.

string

start_time Optional

Time when the operation is started. This field is optional and it is only relevant when the value of CommonInfo.status is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED.

string

end_time Optional

Time when the operation is completed. This field is optional and it is only relevant when the value of CommonInfo.status is one of SUCCEEDED or FAILED.

StdDynamicID

target Optional

Identifier of the target created by the operation or an existing one the operation performed on. This field will be unset if the operation has no target or multiple targets.

integer

duration Optional

Time in seconds since the backup job was started or the time it took to complete the backup job. This field is optional and it is only relevant when the value of CommonInfo#status is one of SUCCEEDED, FAILED, or RUNNING.

string

user Optional

Name of the user who performed the operation. This field will be unset if the operation is performed by the system.

Errors

Error

500

com.vmware.vapi.std.errors.error : if any error occurs during the execution of the operation.

Error

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-ListBackupJobDetails -Jobs "MyJobs"

cURL Command

curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/recovery/backup/job/details

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/backup/job/details
x-vmw-doc-operation: list

Availability

Added in 7.0U2

List Backup Job Details

On This Page

Request

URL

Query Parameters

Header Parameters

vmware-api-session-id example

Authentication

api_key

Response

Response Body

Errors

Code Samples

PowerCLI Client SDK Example

cURL Command

Vendor Extensions

Availability

On This Page

Was this page helpful?