Managed Service for YDB API, gRPC: BackupService.Get
Returns the specified backup.
gRPC request
rpc Get (GetBackupRequest) returns (Backup)
GetBackupRequest
{
"backupId": "string"
}
Field |
Description |
backupId |
string Required field. Required. ID of the YDB backup. |
Backup
{
"id": "string",
"name": "string",
"folderId": "string",
"databaseId": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"startedAt": "google.protobuf.Timestamp",
"completedAt": "google.protobuf.Timestamp",
"status": "Status",
"backupSettings": {
"name": "string",
"description": "string",
"backupSchedule": {
// Includes only one of the fields `dailyBackupSchedule`, `weeklyBackupSchedule`, `recurringBackupSchedule`
"dailyBackupSchedule": {
"executeTime": "google.type.TimeOfDay"
},
"weeklyBackupSchedule": {
"daysOfWeek": [
{
"days": [
"DayOfWeek"
],
"executeTime": "google.type.TimeOfDay"
}
]
},
"recurringBackupSchedule": {
"startTime": "google.protobuf.Timestamp",
"recurrence": "string"
},
// end of the list of possible fields
"nextExecuteTime": "google.protobuf.Timestamp"
},
"backupTimeToLive": "google.protobuf.Duration",
"sourcePaths": [
"string"
],
"sourcePathsToExclude": [
"string"
],
"type": "Type",
"storageClass": "StorageClass"
},
"type": "Type",
"size": "int64"
}
Field |
Description |
id |
string |
name |
string human readable backup name. |
folderId |
string |
databaseId |
string |
description |
string description of backup. |
createdAt |
|
startedAt |
indicates when backup started. |
completedAt |
indicates when backup completed. |
status |
enum Status
|
backupSettings |
settings used to make backup. |
type |
enum Type
|
size |
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 |
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 |
output only field: when next backup will be executed |
DailyBackupSchedule
Field |
Description |
executeTime |
Required field. |
WeeklyBackupSchedule
Field |
Description |
daysOfWeek[] |
DaysOfWeekBackupSchedule
Field |
Description |
days[] |
enum DayOfWeek
|
executeTime |
Required field. |
RecurringBackupSchedule
Field |
Description |
startTime |
Required field. Timestamp of the first recurrence. |
recurrence |
string Required field. An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how |