Cloud Backup API, REST: Backup.List
List backups using filters.
HTTP request
GET https://backup.api.yandexcloud.kz/backup/v1/backups
Query parameters
|
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 |
|
backup |
List backups by specific backup 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.
|
|
pageSize |
string (int64) Number of results per page. The maximum value is 1000. |
|
pageToken |
string Token for the results page. Not allowed to use if listing is performed by specific policy ID. The maximum string length in characters is 100. |
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. |
BackupParameters
|
Field |
Description |
|
backupId |
string Required field. |
|
folderId |
string Required field. |
Response
HTTP Code: 200 - OK
{
"backups": [
{
"id": "string",
"vaultId": "string",
"archiveId": "string",
"createdAt": "string",
"lastSeenAt": "string",
"size": "string",
"deduplicatedSize": "string",
"backedUpDataSize": "string",
"originalDataSize": "string",
"attributes": {
"streamName": "string",
"uri": "string"
},
"computeInstanceId": "string",
"disks": [
{
"deviceModel": "string",
"name": "string",
"size": "string",
"volumes": [
{
"freeSpace": "string",
"isBootable": "boolean",
"isSystem": "boolean",
"name": "string",
"size": "string",
"mountStrid": "string"
}
]
}
],
"type": "string",
"deleted": "boolean",
"policyId": "string",
"resourceId": "string"
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
backups[] |
|
|
nextPageToken |
string Token for the next results page. |
Backup
|
Field |
Description |
|
id |
string ID of the backup. |
|
vaultId |
string ID of the backup vault. |
|
archiveId |
string ID of the backup archive. |
|
createdAt |
string (date-time) String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
lastSeenAt |
string (date-time) String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
size |
string (int64) Backup size. |
|
deduplicatedSize |
string (int64) Deduplicated backup size. |
|
backedUpDataSize |
string (int64) Backed up data size. |
|
originalDataSize |
string (int64) Original data size. |
|
attributes |
|
|
computeInstanceId |
string Compute Cloud instance ID. |
|
disks[] |
|
|
type |
enum (Type)
|
|
deleted |
boolean 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 |
string (int64) Disk size. |
|
volumes[] |
Volume
|
Field |
Description |
|
freeSpace |
string (int64) Free space in the volume. |
|
isBootable |
boolean If this field is true, it means that the volume is bootable. |
|
isSystem |
boolean If this field is true, it means that the volume is a system volume. |
|
name |
string Volume name. |
|
size |
string (int64) Volume size. |
|
mountStrid |
string Mount string ID. |