Cloud Backup API, gRPC: BackupService.List
List backups using filters.
gRPC request
rpc List (ListBackupsRequest) returns (ListBackupsResponse)
ListBackupsRequest
{
// Includes only one of the fields `computeInstanceId`, `archive`, `folderId`, `instancePolicy`, `resourceId`, `policyId`
"computeInstanceId": "string",
"archive": {
"archiveId": "string",
"folderId": "string"
},
"folderId": "string",
"instancePolicy": {
"computeInstanceId": "string",
"policyId": "string"
},
"resourceId": "string",
"policyId": "string",
// end of the list of possible fields
"orderBy": "string",
"filter": "string",
"type": "ResourceType"
}
Field |
Description |
computeInstanceId |
string List backups that belongs to specific Compute Cloud instance. Includes only one of the fields |
archive |
List backups that belongs to specific archive of specific folder. Includes only one of the fields |
folderId |
string List backups that belongs to specific folder. Includes only one of the fields |
instancePolicy |
List backups that belongs to specific instance and policy at the same time. Includes only one of the fields |
resourceId |
string List backups by specific resource ID. Includes only one of the fields |
policyId |
string List backups by specific policy ID. Includes only one of the fields |
orderBy |
string By which column the listing should be ordered and in which direction, |
filter |
string Filter list by various parameters.
Supported logic operators:
|
type |
enum ResourceType Type of resource. Could be compute VM or baremetal server.
|
ArchiveParameters
Field |
Description |
archiveId |
string Required field. Archive ID. |
folderId |
string Required field. Folder ID. |
InstancePolicy
Field |
Description |
computeInstanceId |
string Compute Cloud instance ID. |
policyId |
string Policy ID. |
ListBackupsResponse
{
"backups": [
{
"id": "string",
"vaultId": "string",
"archiveId": "string",
"createdAt": "google.protobuf.Timestamp",
"lastSeenAt": "google.protobuf.Timestamp",
"size": "int64",
"deduplicatedSize": "int64",
"backedUpDataSize": "int64",
"originalDataSize": "int64",
"attributes": {
"streamName": "string",
"uri": "string"
},
"computeInstanceId": "string",
"disks": [
{
"deviceModel": "string",
"name": "string",
"size": "int64",
"volumes": [
{
"freeSpace": "int64",
"isBootable": "bool",
"isSystem": "bool",
"name": "string",
"size": "int64",
"mountStrid": "string"
}
]
}
],
"type": "Type",
"deleted": "bool",
"policyId": "string",
"resourceId": "string"
}
]
}
Field |
Description |
backups[] |
Backup
Field |
Description |
id |
string ID of the backup. |
vaultId |
string ID of the backup vault. |
archiveId |
string ID of the backup archive. |
createdAt |
|
lastSeenAt |
|
size |
int64 Backup size. |
deduplicatedSize |
int64 Deduplicated backup size. |
backedUpDataSize |
int64 Backed up data size. |
originalDataSize |
int64 Original data size. |
attributes |
|
computeInstanceId |
string Compute Cloud instance ID. |
disks[] |
|
type |
enum Type
|
deleted |
bool If this field is true, it means that the backup was deleted. |
policyId |
string Policy ID. |
resourceId |
string Resource ID. It identifies Compute Cloud instance in backup service. |
BackupAttributes
Backup attributes.
Field |
Description |
streamName |
string Backup stream name. |
uri |
string URI of the backup archive. |
Disk
Field |
Description |
deviceModel |
string Device model. |
name |
string Disk name. |
size |
int64 Disk size. |
volumes[] |
Volume
Field |
Description |
freeSpace |
int64 Free space in the volume. |
isBootable |
bool If this field is true, it means that the volume is bootable. |
isSystem |
bool If this field is true, it means that the volume is a system volume. |
name |
string Volume name. |
size |
int64 Volume size. |
mountStrid |
string Mount string ID. |