Cloud Backup API, gRPC: BackupService.ListArchives
List archives that holds backups for specified folder or
specified Compute Cloud instance.
gRPC request
rpc ListArchives (ListArchivesRequest) returns (ListArchivesResponse)
ListArchivesRequest
{
// Includes only one of the fields `folderId`, `computeInstanceId`
"folderId": "string",
"computeInstanceId": "string"
// end of the list of possible fields
}
Field |
Description |
folderId |
string List of archives in specified folder. Includes only one of the fields |
computeInstanceId |
string List of archives of the specified Compute Cloud instance. Includes only one of the fields |
ListArchivesResponse
{
"archives": [
{
"id": "string",
"name": "string",
"vaultId": "string",
"attributes": {
"aaib": "string",
"uri": "string"
},
"size": "int64",
"compressedDataSize": "int64",
"dataSize": "int64",
"originalDataSize": "int64",
"logicalSize": "int64",
"format": "Format",
"createdAt": "google.protobuf.Timestamp",
"updatedAt": "google.protobuf.Timestamp",
"lastBackupCreatedAt": "google.protobuf.Timestamp",
"lastSeenAt": "google.protobuf.Timestamp",
"protectedByPassword": "bool",
"encryptionAlgorithm": "EncryptionAlgorithm",
"actions": [
"Action"
],
"backupPlanId": "string",
"backupPlanName": "string",
"description": "string",
"displayName": "string",
"computeInstanceId": "string",
"consistent": "bool",
"deleted": "bool",
"resourceId": "string"
}
]
}
Field |
Description |
archives[] |
Archive
Archive is a container that holds backups of Compute Cloud instance.
Field |
Description |
id |
string ID of the backup. |
name |
string Name of the backup. |
vaultId |
string ID of the backup vault. |
attributes |
Archive attributes. |
size |
int64 Archive size. |
compressedDataSize |
int64 Compressed data size. |
dataSize |
int64 Data size. |
originalDataSize |
int64 Original data size. |
logicalSize |
int64 Logical size. |
format |
enum Format
|
createdAt |
|
updatedAt |
|
lastBackupCreatedAt |
|
lastSeenAt |
|
protectedByPassword |
bool If this field is true, it means that any of encryption algorithm |
encryptionAlgorithm |
enum EncryptionAlgorithm
|
actions[] |
enum Action
|
backupPlanId |
string Backup plan ID. |
backupPlanName |
string Backup plan name. |
description |
string Backup plan description. |
displayName |
string Display name, e.g. |
computeInstanceId |
string Compute Cloud instance ID. |
consistent |
bool If this field is true, it means that the archive is consistent. |
deleted |
bool If this field is true, it means that the archive was deleted. |
resourceId |
string Resource ID. |
ArchiveAttributes
Archive attributes.
Field |
Description |
aaib |
string Archive attribute. Default value: |
uri |
string URI of the backup archive. |