Managed Service for YDB API, REST: Backup.Get
Returns the specified backup.
HTTP request
GET https://ydb.api.cloud.yandex.net/ydb/v1/backups/{backupId}
Path parameters
Field |
Description |
backupId |
string Required field. Required. ID of the YDB backup. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"name": "string",
"folderId": "string",
"databaseId": "string",
"description": "string",
"createdAt": "string",
"startedAt": "string",
"completedAt": "string",
"status": "string",
"backupSettings": {
"name": "string",
"description": "string",
"backupSchedule": {
// Includes only one of the fields `dailyBackupSchedule`, `weeklyBackupSchedule`, `recurringBackupSchedule`
"dailyBackupSchedule": {
"executeTime": {
"hours": "integer",
"minutes": "integer",
"seconds": "integer",
"nanos": "integer"
}
},
"weeklyBackupSchedule": {
"daysOfWeek": [
{
"days": [
"string"
],
"executeTime": {
"hours": "integer",
"minutes": "integer",
"seconds": "integer",
"nanos": "integer"
}
}
]
},
"recurringBackupSchedule": {
"startTime": "string",
"recurrence": "string"
},
// end of the list of possible fields
"nextExecuteTime": "string"
},
"backupTimeToLive": "string",
"sourcePaths": [
"string"
],
"sourcePathsToExclude": [
"string"
],
"type": "string",
"storageClass": "string"
},
"type": "string",
"size": "string"
}
Field |
Description |
id |
string |
name |
string human readable backup name. |
folderId |
string |
databaseId |
string |
description |
string description of backup. |
createdAt |
string (date-time) String in RFC3339 To work with values in this field, use the APIs described in the |
startedAt |
string (date-time) indicates when backup started. String in RFC3339 To work with values in this field, use the APIs described in the |
completedAt |
string (date-time) indicates when backup completed. String in RFC3339 To work with values in this field, use the APIs described in the |
status |
enum (Status)
|
backupSettings |
settings used to make backup. |
type |
enum (Type)
|
size |
string (int64) size of backup in bytes. |
BackupSettings
Field |
Description |
name |
string name of backup settings |
description |
string human readable description. |
backupSchedule |
provide schedule. if empty, backup will be disabled. |
backupTimeToLive |
string (duration) provide time to live of backup. |
sourcePaths[] |
string provide a list of source paths. Each path can be directory, table or even database itself. |
sourcePathsToExclude[] |
string provide a list of paths to exclude from backup. |
type |
enum (Type)
|
storageClass |
enum (StorageClass)
|
BackupSchedule
Field |
Description |
dailyBackupSchedule |
Includes only one of the fields |
weeklyBackupSchedule |
Includes only one of the fields |
recurringBackupSchedule |
Includes only one of the fields |
nextExecuteTime |
string (date-time) output only field: when next backup will be executed String in RFC3339 To work with values in this field, use the APIs described in the |
DailyBackupSchedule
Field |
Description |
executeTime |
Required field. |
TimeOfDay
Represents a time of day. The date and time zone are either not significant
or are specified elsewhere. An API may choose to allow leap seconds. Related
types are google.type.Date
Field |
Description |
hours |
integer (int32) Hours of day in 24 hour format. Should be from 0 to 23. An API may choose |
minutes |
integer (int32) Minutes of hour of day. Must be from 0 to 59. |
seconds |
integer (int32) Seconds of minutes of the time. Must normally be from 0 to 59. An API may |
nanos |
integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
WeeklyBackupSchedule
Field |
Description |
daysOfWeek[] |
DaysOfWeekBackupSchedule
Field |
Description |
days[] |
enum (DayOfWeek)
|
executeTime |
Required field. |
RecurringBackupSchedule
Field |
Description |
startTime |
string (date-time) Required field. Timestamp of the first recurrence. String in RFC3339 To work with values in this field, use the APIs described in the |
recurrence |
string Required field. An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how |