Связаться с намиПодключиться

Managed Service for YDB API, REST: Backup.List

Статья создана
Обновлена 3 октября 2025 г.

Retrieves a list of backups.

HTTP request

GET https://ydb.api.cloud.yandex.net/ydb/v1/backups

Query parameters

Field

Description

folderId

string

pageSize

string (int64)

The maximum number of results per page that should be returned. If the number of available
results is larger than page_size, the service returns a next_page_token that can be used
to get the next page of results in subsequent ListBackups requests.
Acceptable values are 0 to 1000, inclusive. Default value: 100.

pageToken

string

Page token. Set page_token to the next_page_token returned by a previous ListBackups
request to get the next page of results.

Response

HTTP Code: 200 - OK

{
  "backups": [
    {
      "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"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

backups[]

Backup

nextPageToken

string

This token allows you to get the next page of results for ListBackups requests,
if the number of results is larger than page_size specified in the request.
To get the next page, specify the value of next_page_token as a value for
the page_token parameter in the next ListBackups request. Subsequent ListBackups
requests will have their own next_page_token to continue paging through the results.

Backup

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 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).

startedAt

string (date-time)

indicates when backup started.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).

completedAt

string (date-time)

indicates when backup completed.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).

status

enum (Status)

  • STATUS_UNSPECIFIED
  • CREATING
  • READY
  • ERROR
  • CANCELLED

backupSettings

BackupSettings

settings used to make backup.

type

enum (Type)

  • TYPE_UNSPECIFIED
  • SYSTEM: indicates that backup started by the system.
  • USER

size

string (int64)

size of backup in bytes.

BackupSettings

Field

Description

name

string

name of backup settings

description

string

human readable description.

backupSchedule

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.
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.

sourcePathsToExclude[]

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.

type

enum (Type)

  • TYPE_UNSPECIFIED
  • SYSTEM
  • USER

storageClass

enum (StorageClass)

  • STORAGE_CLASS_UNSPECIFIED
  • STANDARD
  • REDUCED_REDUNDANCY
  • STANDARD_IA
  • ONEZONE_IA
  • INTELLIGENT_TIERING
  • GLACIER
  • DEEP_ARCHIVE
  • OUTPOSTS

BackupSchedule

Field

Description

dailyBackupSchedule

DailyBackupSchedule

Includes only one of the fields dailyBackupSchedule, weeklyBackupSchedule, recurringBackupSchedule.

weeklyBackupSchedule

WeeklyBackupSchedule

Includes only one of the fields dailyBackupSchedule, weeklyBackupSchedule, recurringBackupSchedule.

recurringBackupSchedule

RecurringBackupSchedule

Includes only one of the fields dailyBackupSchedule, weeklyBackupSchedule, recurringBackupSchedule.

nextExecuteTime

string (date-time)

output only field: when next backup will be executed
using provided schedule.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).

DailyBackupSchedule

Field

Description

executeTime

TimeOfDay

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 and google.protobuf.Timestamp.

Field

Description

hours

integer (int32)

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
to allow the value "24:00:00" for scenarios like business closing time.

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
allow the value 60 if it allows leap-seconds.

nanos

integer (int32)

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

WeeklyBackupSchedule

Field

Description

daysOfWeek[]

DaysOfWeekBackupSchedule

DaysOfWeekBackupSchedule

Field

Description

days[]

enum (DayOfWeek)

  • DAY_OF_WEEK_UNSPECIFIED: The unspecified day-of-week.
  • 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.

executeTime

TimeOfDay

Required field.

RecurringBackupSchedule

Field

Description

startTime

string (date-time)

Required field. Timestamp of the first recurrence.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).

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.
Предыдущая
ListPaths
Следующая
Delete