Appliance Recovery Backup SystemName Archive get

Appliance Recovery Backup SystemName Archive get

Returns the information for backup corresponding to given backup location and system name.

This operation was added in vSphere API 6.7.

Request
URI
POST
https://{api_host}/api/appliance/recovery/backup/system-name/{systemName}/archives/{archive}?action=get
COPY
Path Parameters
string
systemName
Required

System name identifier.

The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.

string
archive
Required

Archive identifier.

The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.archive.


Request Body

LocationSpec Structure.

Appliance Recovery Backup LocationSpec of type(s) application/json
Required

Show optional properties

{
    "location": "string"
}
{
    "location": "string",
    "location_user": "string",
    "location_password": "string"
}
string As uri As uri
location
Required

Backup location URL.

This property was added in vSphere API 6.7.

string
location_user
Optional

Username for the given location.

This property was added in vSphere API 6.7.

If missing or null authentication will not be used.

string As password As password
location_password
Optional

Password for the given location.

This property was added in vSphere API 6.7.

If missing or null authentication will not be used.

Authentication
This operation uses the following authentication methods.
Responses
200

Info Structure.

Returns Appliance Recovery Backup SystemName Archive Info of type(s) application/json
"Appliance Recovery Backup SystemName Archive Info Object"
string As date-time As date-time
timestamp
Required

Time when this backup was completed.

This property was added in vSphere API 6.7.

string As uri As uri
location
Required

Backup location URL.

This property was added in vSphere API 6.7.

array of string
parts
Required

List of parts included in the backup.

This property was added in vSphere API 6.7.

string
version
Required

The version of the appliance represented by the backup.

This property was added in vSphere API 6.7.

string
system_name
Required

The system name identifier of the appliance represented by the backup.

This property was added in vSphere API 6.7.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.

string
comment
Required

Custom comment added by the user for this backup.

This property was added in vSphere API 6.7.


404

if backup does not exist.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0
"Vapi Std Errors NotFound Object"

500

if any error occurs during the execution of the operation.

Returns Vapi Std Errors Error of type(s) application/json
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"location:"string"}' https://{api_host}/api/appliance/recovery/backup/system-name/{systemName}/archives/{archive}?action=get