This API has a deprecated equivalent from v7.0U1.
List Backup System Name Archive
Returns information about backup archives corresponding to given backup location and system name, which match the Archive.FilterSpec.
Request
URLURL
https://{api_host}/api/appliance/recovery/backup/system-name/{system_name}/archives?action=list
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.
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
RecoveryBackupSystemNameArchiveListRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"filter_spec": {},
"loc_spec": {
"location": "string"
}
}
filter_spec
Required
Specification of matching backups for which information should be returned.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
RecoveryBackupSystemNameArchiveSummary
of type application/json
Commonly used information about the backup archives.
[
{
"archive": "string",
"comment": "string",
"timestamp": "string",
"version": "string"
}
]
string
archive
Required
Backup archive identifier. 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.archive. 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.archive.
string
comment
Required
Custom comment added by the user for this backup.
string
timestamp
Required
Time when this backup was started.
string
version
Required
The version of the appliance represented by the backup archive.
Errors
404
com.vmware.vapi.std.errors.not_found : if combination of locSpec and system name does not refer to an existing location on the backup server.
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"
$RecoveryBackupSystemNameArchiveFilterSpec = Initialize-RecoveryBackupSystemNameArchiveFilterSpec
$RecoveryBackupSystemNameArchiveListRequestBody = Initialize-RecoveryBackupSystemNameArchiveListRequestBody -LocSpec $RecoveryBackupLocationSpec -FilterSpec $RecoveryBackupSystemNameArchiveFilterSpec
Invoke-ListSystemNameArchives -SystemName "MySystemName" -RecoveryBackupSystemNameArchiveListRequestBody $RecoveryBackupSystemNameArchiveListRequestBody
PowerCLI Client SDK All Parameters Example
$RecoveryBackupLocationSpec = Initialize-RecoveryBackupLocationSpec -Location "MyLocation" -LocationUser "MyLocationUser" -LocationPassword "MyLocationPassword"
$RecoveryBackupSystemNameArchiveFilterSpec = Initialize-RecoveryBackupSystemNameArchiveFilterSpec -StartTimestamp (Get-Date) -EndTimestamp (Get-Date) -CommentSubstring "MyCommentSubstring" -MaxResults 0
$RecoveryBackupSystemNameArchiveListRequestBody = Initialize-RecoveryBackupSystemNameArchiveListRequestBody -LocSpec $RecoveryBackupLocationSpec -FilterSpec $RecoveryBackupSystemNameArchiveFilterSpec
Invoke-ListSystemNameArchives -SystemName "MySystemName" -RecoveryBackupSystemNameArchiveListRequestBody $RecoveryBackupSystemNameArchiveListRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"filter_spec":{"comment_substring":"string","end_timestamp":"string","max_results":0,"start_timestamp":"string"},"loc_spec":{"location":"string","location_password":"string","location_user":"string"}}' https://{api_host}/api/appliance/recovery/backup/system-name/{system_name}/archives?action=list
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
x-vmw-doc-operation: list
Availability
Added in 7.0U2
