This API has a deprecated equivalent from v7.0U1.
Get Backup System Name Archive
Returns the information for backup corresponding to given backup location and system name.
Request
URLURL
https://{api_host}/api/appliance/recovery/backup/system-name/{system_name}/archives/{archive}?action=get
Path Parameters
Path Parameters
string
system_name
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.
Header Parameters
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"
Request Body
Request Body
{
"location": "string"
}
string
location
Required
Backup location URL.
string
location_password
Optional
Password for the given location. If unset authentication will not be used.
string
location_user
Optional
Username for the given location. If unset authentication will not be used.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
RecoveryBackupSystemNameArchiveInfo
of type application/json
Info Structure.
{
"comment": "string",
"location": "string",
"parts": [
"string"
],
"system_name": "string",
"timestamp": "string",
"version": "string"
}
string
comment
Required
Custom comment added by the user for this backup.
string
location
Required
Backup location URL.
array of
string
parts
Required
List of parts included in the backup.
string
system_name
Required
The system name identifier of the appliance represented by the backup. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.appliance.recovery.backup.system_name.
string
timestamp
Required
Time when this backup was completed.
string
version
Required
The version of the appliance represented by the backup.
Errors
500
com.vmware.vapi.std.errors.error : if any error occurs during the execution of the operation.
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
$RecoveryBackupLocationSpec = Initialize-RecoveryBackupLocationSpec -Location "MyLocation"
Invoke-GetSystemNameArchive -SystemName "MySystemName" -Archive "MyArchive" -RecoveryBackupLocationSpec $RecoveryBackupLocationSpec
PowerCLI Client SDK All Parameters Example
$RecoveryBackupLocationSpec = Initialize-RecoveryBackupLocationSpec -Location "MyLocation" -LocationUser "MyLocationUser" -LocationPassword "MyLocationPassword"
Invoke-GetSystemNameArchive -SystemName "MySystemName" -Archive "MyArchive" -RecoveryBackupLocationSpec $RecoveryBackupLocationSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"location":"string","location_password":"string","location_user":"string"}' https://{api_host}/api/appliance/recovery/backup/system-name/{system_name}/archives/{archive}?action=get
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/system-name/{system_name}/archives/{archive}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
