Managed Service for YDB API, gRPC: DatabaseService.Backup

Статья создана

Yandex Cloud

Обновлена 1 июля 2026 г.

Открыть в Markdown

gRPC request
BackupDatabaseRequest
BackupSettings
BackupSchedule
DailyBackupSchedule
WeeklyBackupSchedule
DaysOfWeekBackupSchedule
RecurringBackupSchedule
operation.Operation

gRPC request

rpc Backup (BackupDatabaseRequest) returns (operation.Operation)

BackupDatabaseRequest

{
  "database_id": "string",
  "backup_settings": {
    "name": "string",
    "description": "string",
    "backup_schedule": {
      // Includes only one of the fields `daily_backup_schedule`, `weekly_backup_schedule`, `recurring_backup_schedule`
      "daily_backup_schedule": {
        "execute_time": "google.type.TimeOfDay"
      },
      "weekly_backup_schedule": {
        "days_of_week": [
          {
            "days": [
              "DayOfWeek"
            ],
            "execute_time": "google.type.TimeOfDay"
          }
        ]
      },
      "recurring_backup_schedule": {
        "start_time": "google.protobuf.Timestamp",
        "recurrence": "string"
      },
      // end of the list of possible fields
      "next_execute_time": "google.protobuf.Timestamp"
    },
    "backup_time_to_live": "google.protobuf.Duration",
    "source_paths": [
      "string"
    ],
    "source_paths_to_exclude": [
      "string"
    ],
    "type": "Type",
    "storage_class": "StorageClass"
  }
}

Field

Description

database_id

string

backup_settings

BackupSettings

custom backup options, if required.

BackupSettings

Field	Description
name	string name of backup settings The maximum string length in characters is 256.
description	string human readable description. The maximum string length in characters is 256.
backup_schedule	BackupSchedule provide schedule. if empty, backup will be disabled.
backup_time_to_live	google.protobuf.Duration provide time to live of backup.
source_paths[]	string provide a list of source paths. Each path can be directory, table or even database itself. Each directory (or database) will be traversed recursively and all childs of directory will be included to backup. By default, backup will be created for full database. The maximum number of elements is 256.
source_paths_to_exclude[]	string provide a list of paths to exclude from backup. Each path is a directory, table, or database. Each directory (or database) will be traversed recursively and all childs of directory will be excluded. The maximum number of elements is 256.
type	enum Type `SYSTEM` `USER`
storage_class	enum StorageClass `STANDARD` `REDUCED_REDUNDANCY` `STANDARD_IA` `ONEZONE_IA` `INTELLIGENT_TIERING` `GLACIER` `DEEP_ARCHIVE` `OUTPOSTS`

BackupSchedule

Field	Description
daily_backup_schedule	DailyBackupSchedule Includes only one of the fields `daily_backup_schedule`, `weekly_backup_schedule`, `recurring_backup_schedule`.
weekly_backup_schedule	WeeklyBackupSchedule Includes only one of the fields `daily_backup_schedule`, `weekly_backup_schedule`, `recurring_backup_schedule`.
recurring_backup_schedule	RecurringBackupSchedule Includes only one of the fields `daily_backup_schedule`, `weekly_backup_schedule`, `recurring_backup_schedule`.
next_execute_time	google.protobuf.Timestamp output only field: when next backup will be executed using provided schedule.

DailyBackupSchedule

Field

Description

execute_time

google.type.TimeOfDay

Required field.

WeeklyBackupSchedule

Field

Description

days_of_week[]

DaysOfWeekBackupSchedule

The number of elements must be in the range 1-7.

DaysOfWeekBackupSchedule

Field

Description

days[]

enum DayOfWeek

The number of elements must be in the range 1-7.

MONDAY: The day-of-week of Monday.
TUESDAY: The day-of-week of Tuesday.
WEDNESDAY: The day-of-week of Wednesday.
THURSDAY: The day-of-week of Thursday.
FRIDAY: The day-of-week of Friday.
SATURDAY: The day-of-week of Saturday.
SUNDAY: The day-of-week of Sunday.

execute_time

google.type.TimeOfDay

Required field.

RecurringBackupSchedule

Field

Description

start_time

google.protobuf.Timestamp

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
this backup reccurs.
The FREQ values of MINUTELY, and SECONDLY are not supported.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	google.protobuf.Any The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

Managed Service for YDB API, gRPC: DatabaseService.Backup

gRPC requestgRPC request

BackupDatabaseRequestBackupDatabaseRequest

BackupSettingsBackupSettings

BackupScheduleBackupSchedule

DailyBackupScheduleDailyBackupSchedule

WeeklyBackupScheduleWeeklyBackupSchedule

DaysOfWeekBackupScheduleDaysOfWeekBackupSchedule

RecurringBackupScheduleRecurringBackupSchedule

operation.Operationoperation.Operation

Была ли статья полезна?

gRPC request

BackupDatabaseRequest

BackupSettings

BackupSchedule

DailyBackupSchedule

WeeklyBackupSchedule

DaysOfWeekBackupSchedule

RecurringBackupSchedule

operation.Operation