Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
Yandex Managed Service for MongoDB
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Информация об имеющихся кластерах
    • Создание кластера
    • Подключение к базе данных
      • Обзор способов подключения к базе данных
      • Подключение к нешардированному кластеру
      • Подключение к шардированному кластеру
    • Остановка и запуск кластера
    • Изменение настроек кластера и базы данных
    • Переключение первичной реплики
    • Обновление версии MongoDB
    • Управление базами данных
    • Управление хостами кластера
    • Управление пользователями БД
    • Управление резервными копиями
    • Управление шардами
    • Просмотр логов кластера
    • Удаление кластера
    • Мониторинг состояния кластера и хостов
    • Диагностика производительности
    • Инструменты для анализа производительности
  • Практические руководства
    • Все сценарии
    • Шардирование коллекций
    • Миграция данных в Managed Service for MongoDB
    • Миграция коллекций из стороннего кластера MongoDB
    • Анализ производительности и оптимизация MongoDB
  • Концепции
    • Взаимосвязь ресурсов сервиса
    • Классы хостов
      • Действующие классы хостов
      • Архив
        • До 1 июня 2020 года
      • Использование устаревших классов хостов
    • Сеть в Managed Service for MongoDB
    • Редакции MongoDB
    • Квоты и лимиты
    • Хранилище в Managed Service for MongoDB
    • Резервные копии
    • Репликация
    • Шардирование
    • Пользователи и роли
    • Техническое обслуживание
    • Поддерживаемые клиенты
    • Настройки MongoDB
  • Управление доступом
  • Правила тарификации
    • Действующие правила
    • Архив
      • До 1 января 2019 года
      • С 1 января до 1 марта 2019 года
      • С 1 марта 2019 года до 1 февраля 2020 года
  • Справочник API
    • Аутентификация в API
    • gRPC (англ.)
      • Overview
      • BackupService
      • ClusterService
      • DatabaseService
      • ResourcePresetService
      • UserService
      • OperationService
    • REST (англ.)
      • Overview
      • Backup
        • Overview
        • delete
        • get
        • list
      • Cluster
        • Overview
        • addHosts
        • addShard
        • backup
        • create
        • delete
        • deleteHosts
        • deleteShard
        • enableSharding
        • get
        • getShard
        • list
        • listBackups
        • listHosts
        • listLogs
        • listOperations
        • listShards
        • move
        • rescheduleMaintenance
        • resetupHosts
        • restartHosts
        • restore
        • start
        • stepdownHosts
        • stop
        • streamLogs
        • update
      • Database
        • Overview
        • create
        • delete
        • get
        • list
      • ResourcePreset
        • Overview
        • get
        • list
      • User
        • Overview
        • create
        • delete
        • get
        • grantPermission
        • list
        • revokePermission
        • update
      • Operation
        • Overview
        • get
  • История изменений
  • Вопросы и ответы
    • Общие вопросы
    • Вопросы о MongoDB
    • Все вопросы на одной странице
  1. Справочник API
  2. gRPC (англ.)
  3. BackupService

Managed Service for MongoDB API, gRPC: BackupService

Статья создана
Yandex Cloud
  • Calls BackupService
  • Get
    • GetBackupRequest
    • Backup
  • List
    • ListBackupsRequest
    • ListBackupsResponse
    • Backup
  • Delete
    • DeleteBackupRequest
    • Operation
    • DeleteBackupMetadata

A set of methods for managing MongoDB Backup resources.

Call Description
Get Returns the specified MongoDB backup.
List Retrieves the list of backups available for the specified folder.
Delete Returns the list of available backups for the specified MongoDB cluster.

Calls BackupService

Get

Returns the specified MongoDB backup.
To get the list of available MongoDB backups, make a List request.

rpc Get (GetBackupRequest) returns (Backup)

GetBackupRequest

Field Description
backup_id string
Required. ID of the backup to return information about. To get the backup ID, use a ClusterService.ListBackups request.

Backup

Field Description
id string
ID of the backup. Required.
folder_id string
ID of the folder that the backup belongs to.
created_at google.protobuf.Timestamp
Creation timestamp in RFC3339 text format (i.e. when the backup operation was completed).
source_cluster_id string
ID of the MongoDB cluster that the backup was created for.
started_at google.protobuf.Timestamp
Time when the backup operation was started.
source_shard_names[] string
Shard names used as a source for backup.
size int64
Size of backup in bytes
type enum BackupType
How this backup was created (manual/automatic/etc...)
  • AUTOMATED: Backup created by automated daily schedule
  • MANUAL: Backup created by user request

List

Retrieves the list of backups available for the specified folder.

rpc List (ListBackupsRequest) returns (ListBackupsResponse)

ListBackupsRequest

Field Description
folder_id string
Required. ID of the folder to list backups in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
page_size int64
The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListBackupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token string
Page token. To get the next page of results, set page_token to the ListBackupsResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100.

ListBackupsResponse

Field Description
backups[] Backup
List of Backup resources.
next_page_token string
This token allows you to get the next page of results for list requests. If the number of results is larger than ListBackupsRequest.page_size, use the next_page_token as the value for the ListBackupsRequest.page_token parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Backup

Field Description
id string
ID of the backup. Required.
folder_id string
ID of the folder that the backup belongs to.
created_at google.protobuf.Timestamp
Creation timestamp in RFC3339 text format (i.e. when the backup operation was completed).
source_cluster_id string
ID of the MongoDB cluster that the backup was created for.
started_at google.protobuf.Timestamp
Time when the backup operation was started.
source_shard_names[] string
Shard names used as a source for backup.
size int64
Size of backup in bytes
type enum BackupType
How this backup was created (manual/automatic/etc...)
  • AUTOMATED: Backup created by automated daily schedule
  • MANUAL: Backup created by user request

Delete

Returns the list of available backups for the specified MongoDB cluster.

rpc Delete (DeleteBackupRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteBackupMetadata

    Operation.response:google.protobuf.Empty

DeleteBackupRequest

Field Description
backup_id string
Required. Required. ID of the backup to delete.

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<DeleteBackupMetadata>
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.
result oneof: error or 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.
  error google.rpc.Status
The error result of the operation in case of failure or cancellation.
  response google.protobuf.Any<google.protobuf.Empty>
if operation finished successfully.

DeleteBackupMetadata

Field Description
backup_id string
Required. ID of the deleting MongoDB backup.

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

Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
В этой статье:
  • Calls BackupService
  • Get
  • GetBackupRequest
  • Backup
  • List
  • ListBackupsRequest
  • ListBackupsResponse
  • Backup
  • Delete
  • DeleteBackupRequest
  • Operation
  • DeleteBackupMetadata