appliance recovery backup job details: list

Returns detailed information about the current and historical backup jobs. This operation was added in vSphere API 6.7

Request:

HTTP request

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

?filter.jobs.1=obj-103
&filter.jobs.2=obj-103

Request Query Parameters:

Name Type Description
bold = required
filter filter_spec Optional. Specification of matching backup jobs for which information should be returned.
filter.jobs string[] Identifiers of backup jobs that can match the filter. This attribute was added in vSphere API 6.7

Optional. 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.

Response:

HTTP Status Code: 200

Representation:

{
    "value"[
        {
            "key""obj-103",
            "value"{
                "cancelable"true,
                "description"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "id""string"
                },
                "duration"1,
                "end_time""2015-01-01T22:13:05.651Z",
                "error"{},
                "location""http://myurl.com",
                "location_user""string",
                "messages"[
                    {
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "id""string"
                    },
                    {
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "id""string"
                    }
                ],
                "operation""obj-103",
                "parent""obj-103",
                "progress"{
                    "completed"1,
                    "message"{
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "id""string"
                    },
                    "total"1
                },
                "service""obj-103",
                "size"1,
                "start_time""2015-01-01T22:13:05.651Z",
                "status""PENDING",
                "target"{
                    "id""obj-103",
                    "type""string"
                },
                "type""SCHEDULED",
                "user""string"
            }
        }
    ]
}

Response Type:

Name Type Description
bold = required
value list Map of backup job identifier to Info Structure.List of {"key": string, "value": info}
value[].key string
value[].value info
value[].value.location URI URL of the backup location. This attribute was added in vSphere API 6.7

value[].value.duration long Time in seconds since the backup job was started or the time it took to complete the backup job. This attribute was added in vSphere API 6.7

Optional. It is only relevant when status has value [SUCCEEDED, FAILED, RUNNING]. This field is optional and it is only relevant when the value of #status is one of SUCCEEDED, FAILED, or RUNNING.

value[].value.size long Size of the backup data transferred to remote location. This attribute was added in vSphere API 6.7

Optional. It is only relevant when status has value [SUCCEEDED, FAILED, RUNNING]. This field is optional and it is only relevant when the value of #status is one of SUCCEEDED, FAILED, or RUNNING.

value[].value.progress progress Progress of the job. This attribute was added in vSphere API 6.7

Optional. It is only relevant when status has value [SUCCEEDED, FAILED, RUNNING]. This field is optional and it is only relevant when the value of #status is one of SUCCEEDED, FAILED, or RUNNING.

value[].value.progress.total long Total amount of the work for the operation. This attribute was added in vSphere API 6.7

value[].value.progress.completed long The amount of work completed for the operation. The value can only be incremented. This attribute was added in vSphere API 6.7

value[].value.progress.message localizable_message Message about the work progress. This attribute was added in vSphere API 6.7

value[].value.progress.message.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.

value[].value.progress.message.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.

value[].value.progress.message.args string[] Arguments to be substituted into a message template.

value[].value.location_user string The username for the remote backup location. This attribute was added in vSphere API 6.7

value[].value.type string Type of the backup job. Indicates whether the backup was started manually or as a scheduled backup. This attribute was added in vSphere API 6.7

Defines the type of backup job. This enumeration was added in vSphere API 6.7 Value is one of:
SCHEDULED: Job type is Scheduled. This constant was added in vSphere API 6.7
MANUAL: Job type is Manual. This constant was added in vSphere API 6.7

value[].value.messages localizable_message[] List of any info/warning/error messages returned by the backup job. This attribute was added in vSphere API 6.7

value[].value.messages[].id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.

value[].value.messages[].default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.

value[].value.messages[].args string[] Arguments to be substituted into a message template.

value[].value.description localizable_message Description of the operation associated with the task. This attribute was added in vSphere API 6.7

value[].value.description.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.

value[].value.description.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.

value[].value.description.args string[] Arguments to be substituted into a message template.

value[].value.service string Name of the service containing the operation. This attribute was added in vSphere API 6.7

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.

value[].value.operation string Name of the operation associated with the task. This attribute was added in vSphere API 6.7

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.

value[].value.parent string Parent of the current task. This attribute was added in vSphere API 6.7

Optional. 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.

value[].value.target dynamic_ID Identifier of the target created by the operation or an existing one the operation performed on. This attribute was added in vSphere API 6.7

Optional. This field will be unset if the operation has no target or multiple targets.

value[].value.target.type string The type of resource being identified (for example com.acme.Person).

Services that contain operations for creating and deleting resources typically contain a constant specifying the resource type for the resources being created and deleted. The API metamodel metadata services include a service that allows retrieving all the known resource types.

value[].value.target.id string The identifier for a resource whose type is specified by vapi.std.dynamic_ID.type.

When clients pass a value of this structure as a parameter, the field type must contain the actual resource type. When operations return a value of this structure as a result, the field type will contain the actual resource type.

value[].value.status string Status of the operation associated with the task. This attribute was added in vSphere API 6.7

Defines the status values that can be reported for an operation. This enumeration was added in vSphere API 6.7 Value is one of:
PENDING: The operation is in pending state. This constant was added in vSphere API 6.7
RUNNING: The operation is in progress. This constant was added in vSphere API 6.7
BLOCKED: The operation is blocked. This constant was added in vSphere API 6.7
SUCCEEDED: The operation completed successfully. This constant was added in vSphere API 6.7
FAILED: The operation failed. This constant was added in vSphere API 6.7

value[].value.cancelable boolean Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses. This attribute was added in vSphere API 6.7

value[].value.error exception Description of the error if the operation status is "FAILED". This attribute was added in vSphere API 6.7

Optional. It is only relevant when status has value [FAILED]. If unset the description of why the operation failed will be included in the result of the operation (see cis.task.info.result).

value[].value.start_time date_time Time when the operation is started. This attribute was added in vSphere API 6.7

Optional. It is only relevant when status has value [RUNNING, BLOCKED, SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of status is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED.

value[].value.end_time date_time Time when the operation is completed. This attribute was added in vSphere API 6.7

Optional. It is only relevant when status has value [SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of status is one of SUCCEEDED or FAILED.

value[].value.user string Name of the user who performed the operation. This attribute was added in vSphere API 6.7

Optional. This field will be unset if the operation is performed by the system.

Errors:

HTTP Status Code Type Description
500 error if any error occurs during the execution of the operation.