Cloud Backup API, REST: Backup.list
List backups using filters.
HTTP request
GET https://backup.api.cloud.yandex.net/backup/v1/backups
Query parameters
Parameter | Description |
---|---|
computeInstanceId | List backups that belongs to specific Compute Cloud instance. |
archive.archiveId | Required. Archive ID. |
archive.folderId | Required. Folder ID. |
folderId | List backups that belongs to specific folder. |
instancePolicy.computeInstanceId | Compute Cloud instance ID. |
instancePolicy.policyId | Policy ID. |
resourceId | List backups by specific resource ID. |
policyId | List backups by specific policy ID. |
orderBy | By which column the listing should be ordered and in which direction, format is "createdAt desc". "createdAt desc" if omitted. |
filter | Filter list by various parameters. Supported parameters are:
Supported logic operators:
|
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": true,
"isSystem": true,
"name": "string",
"size": "string",
"mountStrid": "string"
}
]
}
],
"type": "string",
"deleted": true,
"policyId": "string",
"resourceId": "string"
}
]
}
Field | Description |
---|---|
backups[] | object |
backups[]. id |
string ID of the backup. |
backups[]. vaultId |
string ID of the backup vault. |
backups[]. archiveId |
string ID of the backup archive. |
backups[]. 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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
backups[]. 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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
backups[]. size |
string (int64) Backup size. |
backups[]. deduplicatedSize |
string (int64) Deduplicated backup size. |
backups[]. backedUpDataSize |
string (int64) Backed up data size. |
backups[]. originalDataSize |
string (int64) Original data size. |
backups[]. attributes |
object Backup attributes. |
backups[]. attributes. streamName |
string Backup stream name. |
backups[]. attributes. uri |
string URI of the backup archive. |
backups[]. computeInstanceId |
string Compute Cloud instance ID. |
backups[]. disks[] |
object |
backups[]. disks[]. deviceModel |
string Device model. |
backups[]. disks[]. name |
string Disk name. |
backups[]. disks[]. size |
string (int64) Disk size. |
backups[]. disks[]. volumes[] |
object |
backups[]. disks[]. volumes[]. freeSpace |
string (int64) Free space in the volume. |
backups[]. disks[]. volumes[]. isBootable |
boolean (boolean) If this field is true, it means that the volume is bootable. |
backups[]. disks[]. volumes[]. isSystem |
boolean (boolean) If this field is true, it means that the volume is a system volume. |
backups[]. disks[]. volumes[]. name |
string Volume name. |
backups[]. disks[]. volumes[]. size |
string (int64) Volume size. |
backups[]. disks[]. volumes[]. mountStrid |
string Mount string ID. |
backups[]. type |
string Backup type. For detailed information, please see Backup types. |
backups[]. deleted |
boolean (boolean) If this field is true, it means that the backup was deleted. |
backups[]. policyId |
string Policy ID. |
backups[]. resourceId |
string Resource ID. It identifies Compute Cloud instance in backup service. |