Cloud Backup API, REST: Backup.listArchives
List archives that holds backups for specified folder or
specified Compute Cloud instance.
HTTP request
GET https://backup.api.cloud.yandex.net/backup/v1/backups/{computeInstanceId}/archives
Path parameters
Parameter | Description |
---|---|
computeInstanceId | List of archives of the specified Compute Cloud instance. |
Query parameters
Parameter | Description |
---|---|
folderId | List of archives in specified folder. |
Response
HTTP Code: 200 - OK
{
"archives": [
{
"id": "string",
"name": "string",
"vaultId": "string",
"attributes": {
"aaib": "string",
"uri": "string"
},
"size": "string",
"compressedDataSize": "string",
"dataSize": "string",
"originalDataSize": "string",
"logicalSize": "string",
"format": "string",
"createdAt": "string",
"updatedAt": "string",
"lastBackupCreatedAt": "string",
"lastSeenAt": "string",
"protectedByPassword": true,
"encryptionAlgorithm": "string",
"actions": [
"string"
],
"backupPlanId": "string",
"backupPlanName": "string",
"description": "string",
"displayName": "string",
"computeInstanceId": "string",
"consistent": true,
"deleted": true,
"resourceId": "string"
}
]
}
Field | Description |
---|---|
archives[] | object Archive is a container that holds backups of Compute Cloud instance. |
archives[]. id |
string ID of the backup. |
archives[]. name |
string Name of the backup. |
archives[]. vaultId |
string ID of the backup vault. |
archives[]. attributes |
object Archive attributes. Archive attributes. |
archives[]. attributes. aaib |
string Archive attribute. Default value: |
archives[]. attributes. uri |
string URI of the backup archive. |
archives[]. size |
string (int64) Archive size. |
archives[]. compressedDataSize |
string (int64) Compressed data size. |
archives[]. dataSize |
string (int64) Data size. |
archives[]. originalDataSize |
string (int64) Original data size. |
archives[]. logicalSize |
string (int64) Logical size. |
archives[]. format |
string Format of the backup in policy. For backup locations that can be browsed with a file manager, the backup format determines the number of files and their extension.
|
archives[]. 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). |
archives[]. updatedAt |
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). |
archives[]. lastBackupCreatedAt |
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). |
archives[]. 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). |
archives[]. protectedByPassword |
boolean (boolean) If this field is true, it means that any of encryption algorithm has been chosen. |
archives[]. encryptionAlgorithm |
string Encryption Algorithm for underlying backups: |
archives[]. actions[] |
string Action with archive backup: |
archives[]. backupPlanId |
string Backup plan ID. |
archives[]. backupPlanName |
string Backup plan name. |
archives[]. description |
string Backup plan description. |
archives[]. displayName |
string Display name, e.g. |
archives[]. computeInstanceId |
string Compute Cloud instance ID. |
archives[]. consistent |
boolean (boolean) If this field is true, it means that the archive is consistent. |
archives[]. deleted |
boolean (boolean) If this field is true, it means that the archive was deleted. |
archives[]. resourceId |
string Resource ID. |