Подключиться
Yandex Managed Service for MongoDB

ClusterService

Набор методов для управления ресурсами Cluster для MongoDB.

Вызов Описание
Get Возвращает указанный ресурс Cluster для MongoDB.
List Получает список ресурсов Cluster для MongoDB, принадлежащих указанному каталогу.
Create Создает кластер MongoDB в указанном каталоге.
Update Изменяет указанный кластер MongoDB.
Delete Удаляет указанный кластер MongoDB.
Start Запускает указанный кластер MongoDB.
Stop Останавливает указанный кластер MongoDB.
Move Перемещает кластер MongoDB в указанный каталог.
Backup Создает резервную копию для указанного кластера MongoDB.
Restore Создает новый кластер MongoDB с использованием указанной резервной копии.
ListLogs Получает логи для указанного кластера MongoDB.
ListOperations Получает список ресурсов Operation для указанного кластера.
ListBackups Получает список доступных резервных копий для указанного кластера MongoDB.
ListHosts Получает список хостов для указанного кластера.
AddHosts Создает новые хосты для кластера.
DeleteHosts Удаляет указанные хосты кластера.
EnableSharding Включает шардирование для кластера: создает 3 хоста mongocfg и 2 хоста mongos, которые необходимы чтобы добавлять и использовать шарды в кластере.
GetShard Возвращает указанный шард.
ListShards Получает список шардов.
AddShard Создает новый шард.
DeleteShard Удаляет указанный шард.

Вызовы ClusterService

Get

Возвращает указанный ресурс Cluster для MongoDB.
Чтобы получить список доступных кластеров MongoDB, отправьте запрос List.

rpc Get (GetClusterRequest) returns (Cluster)

GetClusterRequest

Поле Описание
cluster_id string
Обязательное поле. Идентификатор возвращаемого ресурса Cluster для MongoDB. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.

Cluster

Поле Описание
id string
Идентификатор кластера MongoDB. Этот идентификатор генерирует MDB при создании.
folder_id string
Идентификатор каталога, которому принадлежит кластер MongoDB.
created_at google.protobuf.Timestamp
Время создания в формате RFC3339 .
name string
Имя кластера MongoDB. Имя уникально в рамках каталога. Длина 1-63 символов.
description string
Описание кластера MongoDB. Длина описания должна быть от 0 до 256 символов.
labels map<string,string>
Пользовательские метки для кластера MongoDB как пары key:value. Максимум 64 на ресурс.
environment enum Environment
Среда развертывания кластера MongoDB.
  • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
  • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
    monitoring[] Monitoring
    Описание систем мониторинга, относящихся к данному кластеру MongoDB.
    config ClusterConfig
    Конфигурация кластера MongoDB.
    network_id string
    Идентификатор сети, к которой принадлежит кластер.
    health enum Health
    Агрегированная работоспособность кластера.
    • HEALTH_UNKNOWN: Состояние кластера неизвестно (Host.health для каждого хоста в кластере — UNKNOWN).
    • ALIVE: Кластер работает нормально (Host.health для каждого хоста в кластере — ALIVE).
    • DEAD: Кластер не работает (Host.health для каждого узла в кластере — DEAD).
    • DEGRADED: Кластер работает неоптимально (Host.health по крайней мере для одного узла в кластере не ALIVE).
      status enum Status
      Текущее состояние кластера.
      • STATUS_UNKNOWN: Состояние кластера неизвестно.
      • CREATING: Кластер создается.
      • RUNNING: Кластер работает нормально.
      • ERROR: На кластере произошла ошибка, блокирующая работу.
      • UPDATING: Кластер изменяется.
      • STOPPING: Кластер останавливается.
      • STOPPED: Кластер остановлен.
      • STARTING: Кластер запускается.
        sharded bool
        Указывает текущее состояние шардирования кластера.

        Monitoring

        Поле Описание
        name string
        Название системы мониторинга.
        description string
        Описание системы мониторинга.
        link string
        Ссылка на графики системы мониторинга для данного кластера MongoDB.

        ClusterConfig

        Поле Описание
        version string
        Версия серверного программного обеспечения MongoDB. Возможные значения: 3.6, 4.0, 4.2.
        feature_compatibility_version string
        • 3.6 — сохранить совместимость данных с версией 3.6. После установки этого параметра данные не будут совместимы с версией 3.4 или ниже.
        • 4.0 — сохранить совместимость данных с версией 4.0. После установки этого параметра данные не будут совместимы с версией 3.6 или ниже.
        • 4.2 — сохранить совместимость данных с версией 4.2. После установки этого параметра данные не будут совместимы с версией 4.0 или ниже.
        mongodb oneof: mongodb_3_6, mongodb_4_0 или mongodb_4_2
        Конфигурация для серверов MongoDB в кластере.
          mongodb_3_6 Mongodb3_6
        Конфигурация и распределение ресурсов для кластера MongoDB 3.6.
          mongodb_4_0 Mongodb4_0
        Конфигурация и распределение ресурсов для кластера MongoDB 4.0.
          mongodb_4_2 Mongodb4_0
        Конфигурация и распределение ресурсов для кластера MongoDB 4.2.
        backup_window_start google.type.TimeOfDay
        Время запуска ежедневного резервного копирования, в часовом поясе UTC.

        Mongodb3_6

        Поле Описание
        mongod Mongod
        Конфигурация и распределение ресурсов для mongod в кластере MongoDB 3.6.
        mongocfg MongoCfg
        Конфигурация и распределение ресурсов mongocfg для кластера MongoDB 3.6.
        mongos Mongos
        Конфигурация и распределение ресурсов mongos для кластера MongoDB 3.6.

        Mongod

        Поле Описание
        config config.MongodConfigSet3_6
        Конфигурация для хостов mongod 3.6.
        resources Resources
        Ресурсы, выделенные хостам MongoDB.

        MongoCfg

        Поле Описание
        config config.MongoCfgConfigSet3_6
        resources Resources
        Ресурсы, выделенные хостам mongocfg.

        Mongos

        Поле Описание
        config config.MongosConfigSet3_6
        resources Resources
        Ресурсы, выделенные хостам mongocfg.

        Mongodb4_0

        Поле Описание
        mongod Mongod
        Конфигурация и распределение ресурсов для mongod в кластере MongoDB 4.0.
        mongocfg MongoCfg
        Конфигурация и распределение ресурсов mongocfg для кластера MongoDB 4.0.
        mongos Mongos
        Конфигурация и распределение ресурсов mongos для кластера MongoDB 4.0.

        Mongod

        Поле Описание
        config config.MongodConfigSet4_0
        Конфигурация для хостов mongod 4.0.
        resources Resources
        Ресурсы, выделенные хостам mongod.

        MongoCfg

        Поле Описание
        config config.MongoCfgConfigSet4_0
        Конфигурация для хостов mongocfg 4.0.
        resources Resources
        Ресурсы, выделенные хостам mongocfg.

        Mongos

        Поле Описание
        config config.MongosConfigSet4_0
        Конфигурация для хостов mongos 4.0.
        resources Resources
        Ресурсы, выделенные хостам mongos.

        List

        Получает список ресурсов Cluster для MongoDB, принадлежащих указанному каталогу.

        rpc List (ListClustersRequest) returns (ListClustersResponse)

        ListClustersRequest

        Поле Описание
        folder_id string
        Обязательное поле. Идентификатор каталога для вывода списка кластеров MongoDB. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50.
        page_size int64
        Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListClustersResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
        page_token string
        Токен страницы. Установите значение page_token равным значению поля ListClustersResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
        filter string
        1. Имя поля. В настоящее время фильтрацию можно использовать только с полем Cluster.name.
        2. Оператор. Операторы = или != для одиночных значений, IN или NOT IN для списков значений.
        3. Значение. Должен содержать от 1 до 63 символов и соответствовать регулярному выражению ^[a-zA-Z0-9_-]+$.
        Максимальная длина строки в символах — 1000.

        ListClustersResponse

        Поле Описание
        clusters[] Cluster
        Список ресурсов Cluster для MongoDB.
        next_page_token string
        Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClustersRequest.page_size, используйте next_page_token в качестве значения параметра ListClustersRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

        Cluster

        Поле Описание
        id string
        Идентификатор кластера MongoDB. Этот идентификатор генерирует MDB при создании.
        folder_id string
        Идентификатор каталога, которому принадлежит кластер MongoDB.
        created_at google.protobuf.Timestamp
        Время создания в формате RFC3339 .
        name string
        Имя кластера MongoDB. Имя уникально в рамках каталога. Длина 1-63 символов.
        description string
        Описание кластера MongoDB. Длина описания должна быть от 0 до 256 символов.
        labels map<string,string>
        Пользовательские метки для кластера MongoDB как пары key:value. Максимум 64 на ресурс.
        environment enum Environment
        Среда развертывания кластера MongoDB.
        • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
        • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
          monitoring[] Monitoring
          Описание систем мониторинга, относящихся к данному кластеру MongoDB.
          config ClusterConfig
          Конфигурация кластера MongoDB.
          network_id string
          Идентификатор сети, к которой принадлежит кластер.
          health enum Health
          Агрегированная работоспособность кластера.
          • HEALTH_UNKNOWN: Состояние кластера неизвестно (Host.health для каждого хоста в кластере — UNKNOWN).
          • ALIVE: Кластер работает нормально (Host.health для каждого хоста в кластере — ALIVE).
          • DEAD: Кластер не работает (Host.health для каждого узла в кластере — DEAD).
          • DEGRADED: Кластер работает неоптимально (Host.health по крайней мере для одного узла в кластере не ALIVE).
            status enum Status
            Текущее состояние кластера.
            • STATUS_UNKNOWN: Состояние кластера неизвестно.
            • CREATING: Кластер создается.
            • RUNNING: Кластер работает нормально.
            • ERROR: На кластере произошла ошибка, блокирующая работу.
            • UPDATING: Кластер изменяется.
            • STOPPING: Кластер останавливается.
            • STOPPED: Кластер остановлен.
            • STARTING: Кластер запускается.
              sharded bool
              Указывает текущее состояние шардирования кластера.

              Monitoring

              Поле Описание
              name string
              Название системы мониторинга.
              description string
              Описание системы мониторинга.
              link string
              Ссылка на графики системы мониторинга для данного кластера MongoDB.

              ClusterConfig

              Поле Описание
              version string
              Версия серверного программного обеспечения MongoDB. Возможные значения: 3.6, 4.0, 4.2.
              feature_compatibility_version string
              • 3.6 — сохранить совместимость данных с версией 3.6. После установки этого параметра данные не будут совместимы с версией 3.4 или ниже.
              • 4.0 — сохранить совместимость данных с версией 4.0. После установки этого параметра данные не будут совместимы с версией 3.6 или ниже.
              • 4.2 — сохранить совместимость данных с версией 4.2. После установки этого параметра данные не будут совместимы с версией 4.0 или ниже.
              mongodb oneof: mongodb_3_6, mongodb_4_0 или mongodb_4_2
              Конфигурация для серверов MongoDB в кластере.
                mongodb_3_6 Mongodb3_6
              Конфигурация и распределение ресурсов для кластера MongoDB 3.6.
                mongodb_4_0 Mongodb4_0
              Конфигурация и распределение ресурсов для кластера MongoDB 4.0.
                mongodb_4_2 Mongodb4_0
              Конфигурация и распределение ресурсов для кластера MongoDB 4.2.
              backup_window_start google.type.TimeOfDay
              Время запуска ежедневного резервного копирования, в часовом поясе UTC.

              Mongodb3_6

              Поле Описание
              mongod Mongod
              Конфигурация и распределение ресурсов для mongod в кластере MongoDB 3.6.
              mongocfg MongoCfg
              Конфигурация и распределение ресурсов mongocfg для кластера MongoDB 3.6.
              mongos Mongos
              Конфигурация и распределение ресурсов mongos для кластера MongoDB 3.6.

              Mongod

              Поле Описание
              config config.MongodConfigSet3_6
              Конфигурация для хостов mongod 3.6.
              resources Resources
              Ресурсы, выделенные хостам MongoDB.

              MongoCfg

              Поле Описание
              config config.MongoCfgConfigSet3_6
              resources Resources
              Ресурсы, выделенные хостам mongocfg.

              Mongos

              Поле Описание
              config config.MongosConfigSet3_6
              resources Resources
              Ресурсы, выделенные хостам mongocfg.

              Mongodb4_0

              Поле Описание
              mongod Mongod
              Конфигурация и распределение ресурсов для mongod в кластере MongoDB 4.0.
              mongocfg MongoCfg
              Конфигурация и распределение ресурсов mongocfg для кластера MongoDB 4.0.
              mongos Mongos
              Конфигурация и распределение ресурсов mongos для кластера MongoDB 4.0.

              Mongod

              Поле Описание
              config config.MongodConfigSet4_0
              Конфигурация для хостов mongod 4.0.
              resources Resources
              Ресурсы, выделенные хостам mongod.

              MongoCfg

              Поле Описание
              config config.MongoCfgConfigSet4_0
              Конфигурация для хостов mongocfg 4.0.
              resources Resources
              Ресурсы, выделенные хостам mongocfg.

              Mongos

              Поле Описание
              config config.MongosConfigSet4_0
              Конфигурация для хостов mongos 4.0.
              resources Resources
              Ресурсы, выделенные хостам mongos.

              Create

              Создает кластер MongoDB в указанном каталоге.

              rpc Create (CreateClusterRequest) returns (operation.Operation)

              Метаданные и результат операции:

                  Operation.metadata:CreateClusterMetadata

                  Operation.response:Cluster

              CreateClusterRequest

              Поле Описание
              folder_id string
              Обязательное поле. Идентификатор каталога, в котором нужно создать кластер MongoDB. Максимальная длина строки в символах — 50.
              name string
              Обязательное поле. Имя кластера MongoDB. Имя должно быть уникальным в каталоге. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]*.
              description string
              Описание кластера MongoDB. Максимальная длина строки в символах — 256.
              labels map<string,string>
              Пользовательские метки для кластера MongoDB как key:value pairs. Maximum 64 per resource. For example, project": "mvp" или "source": "dictionary". Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Максимальная длина строки в символах для каждого ключа — 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* `.
              environment Cluster.Environment
              Обязательное поле. Среда развертывания кластера MongoDB.
              config_spec ConfigSpec
              Обязательное поле. Конфигурация и ресурсы для хостов, которые должны быть созданы для кластера MongoDB.
              database_specs[] DatabaseSpec
              Описания баз данных, которые нужно создать в кластере MongoDB. Количество элементов должно быть больше 0.
              user_specs[] UserSpec
              Описания пользователей базы данных, которых нужно создать в кластере MongoDB. Количество элементов должно быть больше 0.
              host_specs[] HostSpec
              Конфигурации для отдельных хостов, которые должны быть созданы для кластера MongoDB. Количество элементов должно быть больше 0.
              network_id string
              Обязательное поле. Идентификатор сети, в которой нужно создать кластер. Максимальная длина строки в символах — 50.

              ConfigSpec

              Поле Описание
              version string
              Версия MongoDB, используемая в кластере. Возможные значения: 3.6, 4.0, 4.2.
              feature_compatibility_version string
              • 3.6 — сохранить совместимость данных с версией 3.6. После установки этого параметра данные не будут совместимы с версией 3.4 или ниже.
              • 4.0 — сохранить совместимость данных с версией 4.0. После установки этого параметра данные не будут совместимы с версией 3.6 или ниже.
              • 4.2 — сохранить совместимость данных с версией 4.2. После установки этого параметра данные не будут совместимы с версией 4.0 или ниже.
              mongodb_spec oneof: mongodb_spec_3_6, mongodb_spec_4_0 или mongodb_spec_4_2
                mongodb_spec_3_6 MongodbSpec3_6
              Конфигурация и распределение ресурсов для кластера MongoDB 3.6.
                mongodb_spec_4_0 MongodbSpec4_0
              Конфигурация и распределение ресурсов для кластера MongoDB 4.0.
                mongodb_spec_4_2 MongodbSpec4_0
              Конфигурация и распределение ресурсов для кластера MongoDB 4.2.
              backup_window_start google.type.TimeOfDay
              Время запуска ежедневного резервного копирования, в часовом поясе UTC.

              MongodbSpec3_6

              Поле Описание
              mongod Mongod
              Конфигурация и выделенные ресурсы для хостов mongod 3.6.
              mongocfg MongoCfg
              Конфигурация и выделенные ресурсы для хостов mongocfg 3.6.
              mongos Mongos
              Конфигурация и выделенные ресурсы для хостов mongos 3.6.

              Mongod

              Поле Описание
              config config.MongodConfig3_6
              Конфигурация для хостов mongod 3.6.
              resources Resources
              Ресурсы, выделенные каждому хосту mongod.

              MongoCfg

              Поле Описание
              config config.MongoCfgConfig3_6
              Конфигурация для хостов mongocfg 3.6.
              resources Resources
              Ресурсы, выделенные для каждого хоста mongocfg.

              Mongos

              Поле Описание
              config config.MongosConfig3_6
              Конфигурация для хостов mongos 3.6.
              resources Resources
              Ресурсы, выделенные для каждого хоста mongos.

              MongodbSpec4_0

              Поле Описание
              mongod Mongod
              Конфигурация и выделенные ресурсы для хостов mongod 4.0.
              mongocfg MongoCfg
              Конфигурация и выделенные ресурсы для хостов mongocfg 4.0.
              mongos Mongos
              Конфигурация и выделенные ресурсы для хостов mongos 4.0.

              Mongod

              Поле Описание
              config config.MongodConfig4_0
              Конфигурация для хостов mongod 4.0.
              resources Resources
              Ресурсы, выделенные каждому хосту mongod.

              MongoCfg

              Поле Описание
              config config.MongoCfgConfig4_0
              Конфигурация для хостов mongocfg 4.0.
              resources Resources
              Ресурсы, выделенные для каждого хоста mongocfg.

              Mongos

              Поле Описание
              config config.MongosConfig4_0
              Конфигурация для хостов mongos 4.0.
              resources Resources
              Ресурсы, выделенные для каждого хоста mongos.

              DatabaseSpec

              Поле Описание
              name string
              Обязательное поле. Имя базы данных MongoDB. Длина 1-63 символов. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]{1,63}.

              UserSpec

              Поле Описание
              name string
              Обязательное поле. Имя пользователя базы данных MongoDB. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]*.
              password string
              Обязательное поле. Пароль пользователя MongoDB. Длина строки в символах должна быть от 8 до 128.
              permissions[] Permission
              Набор разрешений, которые следует предоставить пользователю.

              Permission

              Поле Описание
              database_name string
              Имя базы данных, к которой предоставляет доступ разрешение.
              roles[] string
              Роли MongoDB базы данных database_name, которые предоставляет разрешение.

              HostSpec

              Поле Описание
              zone_id string
              Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List. Максимальная длина строки в символах — 50.
              subnet_id string
              Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети устанавливается в поле Cluster.network_id. Максимальная длина строки в символах — 50.
              assign_public_ip bool
              • false — не назначать хосту публичный IP-адрес.
              • true — у хоста должен быть публичный IP-адрес.
              type Host.Type
              Тип развертываемого хоста.
              shard_name string
              Имя шарда, которому принадлежит хост. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

              Operation

              Поле Описание
              id string
              Идентификатор операции.
              description string
              Описание операции. Длина описания должна быть от 0 до 256 символов.
              created_at google.protobuf.Timestamp
              Время создания ресурса в формате в RFC3339.
              created_by string
              Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
              modified_at google.protobuf.Timestamp
              Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
              done bool
              Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
              metadata google.protobuf.Any<CreateClusterMetadata>
              Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
              result oneof: error или response
              Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                error google.rpc.Status
              Описание ошибки в случае сбоя или отмены операции.
                response google.protobuf.Any<Cluster>
              в случае успешного выполнения операции.

              CreateClusterMetadata

              Поле Описание
              cluster_id string
              Идентификатор создаваемого кластера MongoDB.

              Cluster

              Поле Описание
              id string
              Идентификатор кластера MongoDB. Этот идентификатор генерирует MDB при создании.
              folder_id string
              Идентификатор каталога, которому принадлежит кластер MongoDB.
              created_at google.protobuf.Timestamp
              Время создания в формате RFC3339 .
              name string
              Имя кластера MongoDB. Имя уникально в рамках каталога. Длина 1-63 символов.
              description string
              Описание кластера MongoDB. Длина описания должна быть от 0 до 256 символов.
              labels map<string,string>
              Пользовательские метки для кластера MongoDB как пары key:value. Максимум 64 на ресурс.
              environment enum Environment
              Среда развертывания кластера MongoDB.
              • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
              • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                monitoring[] Monitoring
                Описание систем мониторинга, относящихся к данному кластеру MongoDB.
                config ClusterConfig
                Конфигурация кластера MongoDB.
                network_id string
                Идентификатор сети, к которой принадлежит кластер.
                health enum Health
                Агрегированная работоспособность кластера.
                • HEALTH_UNKNOWN: Состояние кластера неизвестно (Host.health для каждого хоста в кластере — UNKNOWN).
                • ALIVE: Кластер работает нормально (Host.health для каждого хоста в кластере — ALIVE).
                • DEAD: Кластер не работает (Host.health для каждого узла в кластере — DEAD).
                • DEGRADED: Кластер работает неоптимально (Host.health по крайней мере для одного узла в кластере не ALIVE).
                  status enum Status
                  Текущее состояние кластера.
                  • STATUS_UNKNOWN: Состояние кластера неизвестно.
                  • CREATING: Кластер создается.
                  • RUNNING: Кластер работает нормально.
                  • ERROR: На кластере произошла ошибка, блокирующая работу.
                  • UPDATING: Кластер изменяется.
                  • STOPPING: Кластер останавливается.
                  • STOPPED: Кластер остановлен.
                  • STARTING: Кластер запускается.
                    sharded bool
                    Указывает текущее состояние шардирования кластера.

                    Update

                    Изменяет указанный кластер MongoDB.

                    rpc Update (UpdateClusterRequest) returns (operation.Operation)

                    Метаданные и результат операции:

                        Operation.metadata:UpdateClusterMetadata

                        Operation.response:Cluster

                    UpdateClusterRequest

                    Поле Описание
                    cluster_id string
                    Обязательное поле. Идентификатор изменяемого ресурса Cluster для MongoDB. Чтобы получить идентификатор кластера MongoDB, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                    update_mask google.protobuf.FieldMask
                    Маска, которая указывает, какие поля ресурса Cluster для MongoDB должны быть изменены.
                    description string
                    Новое описание кластера MongoDB. Максимальная длина строки в символах — 256.
                    labels map<string,string>
                    Пользовательские метки для кластера MongoDB как "key:value `` pairs. Maximum 64 per resource. For example,project": "mvp" или "source": "dictionary".
                    Новый набор меток полностью заменит старый. Чтобы добавить метку, запросите текущий набор меток с помощью метода ClusterService.Get, затем отправьте запрос ClusterService.Update, добавив новую метку в этот набор. Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]*. Максимальная длина строки в символах для каждого ключа — 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]*.
                    config_spec ConfigSpec
                    Новая конфигурация и ресурсы для хостов кластера.

                    ConfigSpec

                    Поле Описание
                    version string
                    Версия MongoDB, используемая в кластере. Возможные значения: 3.6, 4.0, 4.2.
                    feature_compatibility_version string
                    • 3.6 — сохранить совместимость данных с версией 3.6. После установки этого параметра данные не будут совместимы с версией 3.4 или ниже.
                    • 4.0 — сохранить совместимость данных с версией 4.0. После установки этого параметра данные не будут совместимы с версией 3.6 или ниже.
                    • 4.2 — сохранить совместимость данных с версией 4.2. После установки этого параметра данные не будут совместимы с версией 4.0 или ниже.
                    mongodb_spec oneof: mongodb_spec_3_6, mongodb_spec_4_0 или mongodb_spec_4_2
                      mongodb_spec_3_6 MongodbSpec3_6
                    Конфигурация и распределение ресурсов для кластера MongoDB 3.6.
                      mongodb_spec_4_0 MongodbSpec4_0
                    Конфигурация и распределение ресурсов для кластера MongoDB 4.0.
                      mongodb_spec_4_2 MongodbSpec4_0
                    Конфигурация и распределение ресурсов для кластера MongoDB 4.2.
                    backup_window_start google.type.TimeOfDay
                    Время запуска ежедневного резервного копирования, в часовом поясе UTC.

                    MongodbSpec3_6

                    Поле Описание
                    mongod Mongod
                    Конфигурация и выделенные ресурсы для хостов mongod 3.6.
                    mongocfg MongoCfg
                    Конфигурация и выделенные ресурсы для хостов mongocfg 3.6.
                    mongos Mongos
                    Конфигурация и выделенные ресурсы для хостов mongos 3.6.

                    Mongod

                    Поле Описание
                    config config.MongodConfig3_6
                    Конфигурация для хостов mongod 3.6.
                    resources Resources
                    Ресурсы, выделенные каждому хосту mongod.

                    MongoCfg

                    Поле Описание
                    config config.MongoCfgConfig3_6
                    Конфигурация для хостов mongocfg 3.6.
                    resources Resources
                    Ресурсы, выделенные для каждого хоста mongocfg.

                    Mongos

                    Поле Описание
                    config config.MongosConfig3_6
                    Конфигурация для хостов mongos 3.6.
                    resources Resources
                    Ресурсы, выделенные для каждого хоста mongos.

                    MongodbSpec4_0

                    Поле Описание
                    mongod Mongod
                    Конфигурация и выделенные ресурсы для хостов mongod 4.0.
                    mongocfg MongoCfg
                    Конфигурация и выделенные ресурсы для хостов mongocfg 4.0.
                    mongos Mongos
                    Конфигурация и выделенные ресурсы для хостов mongos 4.0.

                    Mongod

                    Поле Описание
                    config config.MongodConfig4_0
                    Конфигурация для хостов mongod 4.0.
                    resources Resources
                    Ресурсы, выделенные каждому хосту mongod.

                    MongoCfg

                    Поле Описание
                    config config.MongoCfgConfig4_0
                    Конфигурация для хостов mongocfg 4.0.
                    resources Resources
                    Ресурсы, выделенные для каждого хоста mongocfg.

                    Mongos

                    Поле Описание
                    config config.MongosConfig4_0
                    Конфигурация для хостов mongos 4.0.
                    resources Resources
                    Ресурсы, выделенные для каждого хоста mongos.

                    Operation

                    Поле Описание
                    id string
                    Идентификатор операции.
                    description string
                    Описание операции. Длина описания должна быть от 0 до 256 символов.
                    created_at google.protobuf.Timestamp
                    Время создания ресурса в формате в RFC3339.
                    created_by string
                    Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                    modified_at google.protobuf.Timestamp
                    Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                    done bool
                    Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                    metadata google.protobuf.Any<UpdateClusterMetadata>
                    Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                    result oneof: error или response
                    Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                      error google.rpc.Status
                    Описание ошибки в случае сбоя или отмены операции.
                      response google.protobuf.Any<Cluster>
                    в случае успешного выполнения операции.

                    UpdateClusterMetadata

                    Поле Описание
                    cluster_id string
                    Идентификатор изменяемого ресурса Cluster для MongoDB.

                    Cluster

                    Поле Описание
                    id string
                    Идентификатор кластера MongoDB. Этот идентификатор генерирует MDB при создании.
                    folder_id string
                    Идентификатор каталога, которому принадлежит кластер MongoDB.
                    created_at google.protobuf.Timestamp
                    Время создания в формате RFC3339 .
                    name string
                    Имя кластера MongoDB. Имя уникально в рамках каталога. Длина 1-63 символов.
                    description string
                    Описание кластера MongoDB. Длина описания должна быть от 0 до 256 символов.
                    labels map<string,string>
                    Пользовательские метки для кластера MongoDB как пары key:value. Максимум 64 на ресурс.
                    environment enum Environment
                    Среда развертывания кластера MongoDB.
                    • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                    • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                      monitoring[] Monitoring
                      Описание систем мониторинга, относящихся к данному кластеру MongoDB.
                      config ClusterConfig
                      Конфигурация кластера MongoDB.
                      network_id string
                      Идентификатор сети, к которой принадлежит кластер.
                      health enum Health
                      Агрегированная работоспособность кластера.
                      • HEALTH_UNKNOWN: Состояние кластера неизвестно (Host.health для каждого хоста в кластере — UNKNOWN).
                      • ALIVE: Кластер работает нормально (Host.health для каждого хоста в кластере — ALIVE).
                      • DEAD: Кластер не работает (Host.health для каждого узла в кластере — DEAD).
                      • DEGRADED: Кластер работает неоптимально (Host.health по крайней мере для одного узла в кластере не ALIVE).
                        status enum Status
                        Текущее состояние кластера.
                        • STATUS_UNKNOWN: Состояние кластера неизвестно.
                        • CREATING: Кластер создается.
                        • RUNNING: Кластер работает нормально.
                        • ERROR: На кластере произошла ошибка, блокирующая работу.
                        • UPDATING: Кластер изменяется.
                        • STOPPING: Кластер останавливается.
                        • STOPPED: Кластер остановлен.
                        • STARTING: Кластер запускается.
                          sharded bool
                          Указывает текущее состояние шардирования кластера.

                          Delete

                          Удаляет указанный кластер MongoDB.

                          rpc Delete (DeleteClusterRequest) returns (operation.Operation)

                          Метаданные и результат операции:

                              Operation.metadata:DeleteClusterMetadata

                              Operation.response:google.protobuf.Empty

                          DeleteClusterRequest

                          Поле Описание
                          cluster_id string
                          Обязательное поле. Идентификатор кластера MongoDB, который следует удалить. Чтобы получить идентификатор кластера MongoDB, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.

                          Operation

                          Поле Описание
                          id string
                          Идентификатор операции.
                          description string
                          Описание операции. Длина описания должна быть от 0 до 256 символов.
                          created_at google.protobuf.Timestamp
                          Время создания ресурса в формате в RFC3339.
                          created_by string
                          Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                          modified_at google.protobuf.Timestamp
                          Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                          done bool
                          Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                          metadata google.protobuf.Any<DeleteClusterMetadata>
                          Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                          result oneof: error или response
                          Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                            error google.rpc.Status
                          Описание ошибки в случае сбоя или отмены операции.
                            response google.protobuf.Any<google.protobuf.Empty>
                          в случае успешного выполнения операции.

                          DeleteClusterMetadata

                          Поле Описание
                          cluster_id string
                          Идентификатор удаляемого кластера MongoDB.

                          Start

                          Запускает указанный кластер MongoDB.

                          rpc Start (StartClusterRequest) returns (operation.Operation)

                          Метаданные и результат операции:

                              Operation.metadata:StartClusterMetadata

                              Operation.response:Cluster

                          StartClusterRequest

                          Поле Описание
                          cluster_id string
                          Обязательное поле. Идентификатор кластера MongoDB, который следует запустить. Максимальная длина строки в символах — 50.

                          Operation

                          Поле Описание
                          id string
                          Идентификатор операции.
                          description string
                          Описание операции. Длина описания должна быть от 0 до 256 символов.
                          created_at google.protobuf.Timestamp
                          Время создания ресурса в формате в RFC3339.
                          created_by string
                          Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                          modified_at google.protobuf.Timestamp
                          Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                          done bool
                          Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                          metadata google.protobuf.Any<StartClusterMetadata>
                          Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                          result oneof: error или response
                          Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                            error google.rpc.Status
                          Описание ошибки в случае сбоя или отмены операции.
                            response google.protobuf.Any<Cluster>
                          в случае успешного выполнения операции.

                          StartClusterMetadata

                          Поле Описание
                          cluster_id string
                          Идентификатор кластера MongoDB.

                          Cluster

                          Поле Описание
                          id string
                          Идентификатор кластера MongoDB. Этот идентификатор генерирует MDB при создании.
                          folder_id string
                          Идентификатор каталога, которому принадлежит кластер MongoDB.
                          created_at google.protobuf.Timestamp
                          Время создания в формате RFC3339 .
                          name string
                          Имя кластера MongoDB. Имя уникально в рамках каталога. Длина 1-63 символов.
                          description string
                          Описание кластера MongoDB. Длина описания должна быть от 0 до 256 символов.
                          labels map<string,string>
                          Пользовательские метки для кластера MongoDB как пары key:value. Максимум 64 на ресурс.
                          environment enum Environment
                          Среда развертывания кластера MongoDB.
                          • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                          • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                            monitoring[] Monitoring
                            Описание систем мониторинга, относящихся к данному кластеру MongoDB.
                            config ClusterConfig
                            Конфигурация кластера MongoDB.
                            network_id string
                            Идентификатор сети, к которой принадлежит кластер.
                            health enum Health
                            Агрегированная работоспособность кластера.
                            • HEALTH_UNKNOWN: Состояние кластера неизвестно (Host.health для каждого хоста в кластере — UNKNOWN).
                            • ALIVE: Кластер работает нормально (Host.health для каждого хоста в кластере — ALIVE).
                            • DEAD: Кластер не работает (Host.health для каждого узла в кластере — DEAD).
                            • DEGRADED: Кластер работает неоптимально (Host.health по крайней мере для одного узла в кластере не ALIVE).
                              status enum Status
                              Текущее состояние кластера.
                              • STATUS_UNKNOWN: Состояние кластера неизвестно.
                              • CREATING: Кластер создается.
                              • RUNNING: Кластер работает нормально.
                              • ERROR: На кластере произошла ошибка, блокирующая работу.
                              • UPDATING: Кластер изменяется.
                              • STOPPING: Кластер останавливается.
                              • STOPPED: Кластер остановлен.
                              • STARTING: Кластер запускается.
                                sharded bool
                                Указывает текущее состояние шардирования кластера.

                                Stop

                                Останавливает указанный кластер MongoDB.

                                rpc Stop (StopClusterRequest) returns (operation.Operation)

                                Метаданные и результат операции:

                                    Operation.metadata:StopClusterMetadata

                                    Operation.response:Cluster

                                StopClusterRequest

                                Поле Описание
                                cluster_id string
                                Обязательное поле. Идентификатор кластера MongoDB, который следует остановить. Максимальная длина строки в символах — 50.

                                Operation

                                Поле Описание
                                id string
                                Идентификатор операции.
                                description string
                                Описание операции. Длина описания должна быть от 0 до 256 символов.
                                created_at google.protobuf.Timestamp
                                Время создания ресурса в формате в RFC3339.
                                created_by string
                                Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                modified_at google.protobuf.Timestamp
                                Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                done bool
                                Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                metadata google.protobuf.Any<StopClusterMetadata>
                                Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                result oneof: error или response
                                Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                  error google.rpc.Status
                                Описание ошибки в случае сбоя или отмены операции.
                                  response google.protobuf.Any<Cluster>
                                в случае успешного выполнения операции.

                                StopClusterMetadata

                                Поле Описание
                                cluster_id string
                                Идентификатор кластера MongoDB.

                                Cluster

                                Поле Описание
                                id string
                                Идентификатор кластера MongoDB. Этот идентификатор генерирует MDB при создании.
                                folder_id string
                                Идентификатор каталога, которому принадлежит кластер MongoDB.
                                created_at google.protobuf.Timestamp
                                Время создания в формате RFC3339 .
                                name string
                                Имя кластера MongoDB. Имя уникально в рамках каталога. Длина 1-63 символов.
                                description string
                                Описание кластера MongoDB. Длина описания должна быть от 0 до 256 символов.
                                labels map<string,string>
                                Пользовательские метки для кластера MongoDB как пары key:value. Максимум 64 на ресурс.
                                environment enum Environment
                                Среда развертывания кластера MongoDB.
                                • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                                • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                                  monitoring[] Monitoring
                                  Описание систем мониторинга, относящихся к данному кластеру MongoDB.
                                  config ClusterConfig
                                  Конфигурация кластера MongoDB.
                                  network_id string
                                  Идентификатор сети, к которой принадлежит кластер.
                                  health enum Health
                                  Агрегированная работоспособность кластера.
                                  • HEALTH_UNKNOWN: Состояние кластера неизвестно (Host.health для каждого хоста в кластере — UNKNOWN).
                                  • ALIVE: Кластер работает нормально (Host.health для каждого хоста в кластере — ALIVE).
                                  • DEAD: Кластер не работает (Host.health для каждого узла в кластере — DEAD).
                                  • DEGRADED: Кластер работает неоптимально (Host.health по крайней мере для одного узла в кластере не ALIVE).
                                    status enum Status
                                    Текущее состояние кластера.
                                    • STATUS_UNKNOWN: Состояние кластера неизвестно.
                                    • CREATING: Кластер создается.
                                    • RUNNING: Кластер работает нормально.
                                    • ERROR: На кластере произошла ошибка, блокирующая работу.
                                    • UPDATING: Кластер изменяется.
                                    • STOPPING: Кластер останавливается.
                                    • STOPPED: Кластер остановлен.
                                    • STARTING: Кластер запускается.
                                      sharded bool
                                      Указывает текущее состояние шардирования кластера.

                                      Move

                                      Перемещает кластер MongoDB в указанный каталог.

                                      rpc Move (MoveClusterRequest) returns (operation.Operation)

                                      Метаданные и результат операции:

                                          Operation.metadata:MoveClusterMetadata

                                          Operation.response:Cluster

                                      MoveClusterRequest

                                      Поле Описание
                                      cluster_id string
                                      Обязательное поле. Идентификатор кластера MongoDB, который следует переместить. Максимальная длина строки в символах — 50.
                                      destination_folder_id string
                                      Обязательное поле. Идентификатор каталога, в который следует переместить кластер. Максимальная длина строки в символах — 50.

                                      Operation

                                      Поле Описание
                                      id string
                                      Идентификатор операции.
                                      description string
                                      Описание операции. Длина описания должна быть от 0 до 256 символов.
                                      created_at google.protobuf.Timestamp
                                      Время создания ресурса в формате в RFC3339.
                                      created_by string
                                      Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                      modified_at google.protobuf.Timestamp
                                      Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                      done bool
                                      Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                      metadata google.protobuf.Any<MoveClusterMetadata>
                                      Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                      result oneof: error или response
                                      Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                        error google.rpc.Status
                                      Описание ошибки в случае сбоя или отмены операции.
                                        response google.protobuf.Any<Cluster>
                                      в случае успешного выполнения операции.

                                      MoveClusterMetadata

                                      Поле Описание
                                      cluster_id string
                                      Идентификатор перемещаемого кластера MongoDB.
                                      source_folder_id string
                                      Идентификатор исходного каталога.
                                      destination_folder_id string
                                      Идентификатор каталога назначения.

                                      Cluster

                                      Поле Описание
                                      id string
                                      Идентификатор кластера MongoDB. Этот идентификатор генерирует MDB при создании.
                                      folder_id string
                                      Идентификатор каталога, которому принадлежит кластер MongoDB.
                                      created_at google.protobuf.Timestamp
                                      Время создания в формате RFC3339 .
                                      name string
                                      Имя кластера MongoDB. Имя уникально в рамках каталога. Длина 1-63 символов.
                                      description string
                                      Описание кластера MongoDB. Длина описания должна быть от 0 до 256 символов.
                                      labels map<string,string>
                                      Пользовательские метки для кластера MongoDB как пары key:value. Максимум 64 на ресурс.
                                      environment enum Environment
                                      Среда развертывания кластера MongoDB.
                                      • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                                      • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                                        monitoring[] Monitoring
                                        Описание систем мониторинга, относящихся к данному кластеру MongoDB.
                                        config ClusterConfig
                                        Конфигурация кластера MongoDB.
                                        network_id string
                                        Идентификатор сети, к которой принадлежит кластер.
                                        health enum Health
                                        Агрегированная работоспособность кластера.
                                        • HEALTH_UNKNOWN: Состояние кластера неизвестно (Host.health для каждого хоста в кластере — UNKNOWN).
                                        • ALIVE: Кластер работает нормально (Host.health для каждого хоста в кластере — ALIVE).
                                        • DEAD: Кластер не работает (Host.health для каждого узла в кластере — DEAD).
                                        • DEGRADED: Кластер работает неоптимально (Host.health по крайней мере для одного узла в кластере не ALIVE).
                                          status enum Status
                                          Текущее состояние кластера.
                                          • STATUS_UNKNOWN: Состояние кластера неизвестно.
                                          • CREATING: Кластер создается.
                                          • RUNNING: Кластер работает нормально.
                                          • ERROR: На кластере произошла ошибка, блокирующая работу.
                                          • UPDATING: Кластер изменяется.
                                          • STOPPING: Кластер останавливается.
                                          • STOPPED: Кластер остановлен.
                                          • STARTING: Кластер запускается.
                                            sharded bool
                                            Указывает текущее состояние шардирования кластера.

                                            Backup

                                            Создает резервную копию для указанного кластера MongoDB.

                                            rpc Backup (BackupClusterRequest) returns (operation.Operation)

                                            Метаданные и результат операции:

                                                Operation.metadata:BackupClusterMetadata

                                                Operation.response:Cluster

                                            BackupClusterRequest

                                            Поле Описание
                                            cluster_id string
                                            Обязательное поле. Идентификатор кластера MongoDB, для которого следует создать резервную копию. Чтобы получить идентификатор кластера MongoDB, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.

                                            Operation

                                            Поле Описание
                                            id string
                                            Идентификатор операции.
                                            description string
                                            Описание операции. Длина описания должна быть от 0 до 256 символов.
                                            created_at google.protobuf.Timestamp
                                            Время создания ресурса в формате в RFC3339.
                                            created_by string
                                            Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                            modified_at google.protobuf.Timestamp
                                            Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                            done bool
                                            Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                            metadata google.protobuf.Any<BackupClusterMetadata>
                                            Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                            result oneof: error или response
                                            Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                              error google.rpc.Status
                                            Описание ошибки в случае сбоя или отмены операции.
                                              response google.protobuf.Any<Cluster>
                                            в случае успешного выполнения операции.

                                            BackupClusterMetadata

                                            Поле Описание
                                            cluster_id string
                                            Идентификатор кластера MongoDB, для которого выполняется резервное копирование.

                                            Cluster

                                            Поле Описание
                                            id string
                                            Идентификатор кластера MongoDB. Этот идентификатор генерирует MDB при создании.
                                            folder_id string
                                            Идентификатор каталога, которому принадлежит кластер MongoDB.
                                            created_at google.protobuf.Timestamp
                                            Время создания в формате RFC3339 .
                                            name string
                                            Имя кластера MongoDB. Имя уникально в рамках каталога. Длина 1-63 символов.
                                            description string
                                            Описание кластера MongoDB. Длина описания должна быть от 0 до 256 символов.
                                            labels map<string,string>
                                            Пользовательские метки для кластера MongoDB как пары key:value. Максимум 64 на ресурс.
                                            environment enum Environment
                                            Среда развертывания кластера MongoDB.
                                            • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                                            • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                                              monitoring[] Monitoring
                                              Описание систем мониторинга, относящихся к данному кластеру MongoDB.
                                              config ClusterConfig
                                              Конфигурация кластера MongoDB.
                                              network_id string
                                              Идентификатор сети, к которой принадлежит кластер.
                                              health enum Health
                                              Агрегированная работоспособность кластера.
                                              • HEALTH_UNKNOWN: Состояние кластера неизвестно (Host.health для каждого хоста в кластере — UNKNOWN).
                                              • ALIVE: Кластер работает нормально (Host.health для каждого хоста в кластере — ALIVE).
                                              • DEAD: Кластер не работает (Host.health для каждого узла в кластере — DEAD).
                                              • DEGRADED: Кластер работает неоптимально (Host.health по крайней мере для одного узла в кластере не ALIVE).
                                                status enum Status
                                                Текущее состояние кластера.
                                                • STATUS_UNKNOWN: Состояние кластера неизвестно.
                                                • CREATING: Кластер создается.
                                                • RUNNING: Кластер работает нормально.
                                                • ERROR: На кластере произошла ошибка, блокирующая работу.
                                                • UPDATING: Кластер изменяется.
                                                • STOPPING: Кластер останавливается.
                                                • STOPPED: Кластер остановлен.
                                                • STARTING: Кластер запускается.
                                                  sharded bool
                                                  Указывает текущее состояние шардирования кластера.

                                                  Restore

                                                  Создает новый кластер MongoDB с использованием указанной резервной копии.

                                                  rpc Restore (RestoreClusterRequest) returns (operation.Operation)

                                                  Метаданные и результат операции:

                                                      Operation.metadata:RestoreClusterMetadata

                                                      Operation.response:Cluster

                                                  RestoreClusterRequest

                                                  Поле Описание
                                                  backup_id string
                                                  Обязательное поле. Идентификатор резервной копии, из которой следует создать кластер. Чтобы получить идентификатор резервной копии, используйте запрос ClusterService.ListBackups.
                                                  name string
                                                  Обязательное поле. Имя нового кластера MongoDB. Имя должно быть уникальным в каталоге. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.
                                                  description string
                                                  Описание нового кластера MongoDB. Максимальная длина строки в символах — 256.
                                                  labels map<string,string>
                                                  Пользовательские метки для кластера MongoDB как "key:value `` пары. Максимум 64 на ресурс. Например, "project": "mvp" или "source": "dictionary". Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Максимальная длина строки в символах для каждого ключа — 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* `.
                                                  environment Cluster.Environment
                                                  Обязательное поле. Среда развертывания для нового кластера MongoDB.
                                                  config_spec ConfigSpec
                                                  Обязательное поле. Конфигурация для создаваемого кластера MongoDB.
                                                  host_specs[] HostSpec
                                                  Конфигурации для хостов MongoDB, которые должны быть созданы для кластера, создаваемого из резервной копии. Количество элементов должно быть больше 0.
                                                  network_id string
                                                  Обязательное поле. Идентификатор сети, в которой нужно создать кластер MongoDB. Максимальная длина строки в символах — 50.

                                                  ConfigSpec

                                                  Поле Описание
                                                  version string
                                                  Версия MongoDB, используемая в кластере. Возможные значения: 3.6, 4.0, 4.2.
                                                  feature_compatibility_version string
                                                  • 3.6 — сохранить совместимость данных с версией 3.6. После установки этого параметра данные не будут совместимы с версией 3.4 или ниже.
                                                  • 4.0 — сохранить совместимость данных с версией 4.0. После установки этого параметра данные не будут совместимы с версией 3.6 или ниже.
                                                  • 4.2 — сохранить совместимость данных с версией 4.2. После установки этого параметра данные не будут совместимы с версией 4.0 или ниже.
                                                  mongodb_spec oneof: mongodb_spec_3_6, mongodb_spec_4_0 или mongodb_spec_4_2
                                                    mongodb_spec_3_6 MongodbSpec3_6
                                                  Конфигурация и распределение ресурсов для кластера MongoDB 3.6.
                                                    mongodb_spec_4_0 MongodbSpec4_0
                                                  Конфигурация и распределение ресурсов для кластера MongoDB 4.0.
                                                    mongodb_spec_4_2 MongodbSpec4_0
                                                  Конфигурация и распределение ресурсов для кластера MongoDB 4.2.
                                                  backup_window_start google.type.TimeOfDay
                                                  Время запуска ежедневного резервного копирования, в часовом поясе UTC.

                                                  MongodbSpec3_6

                                                  Поле Описание
                                                  mongod Mongod
                                                  Конфигурация и выделенные ресурсы для хостов mongod 3.6.
                                                  mongocfg MongoCfg
                                                  Конфигурация и выделенные ресурсы для хостов mongocfg 3.6.
                                                  mongos Mongos
                                                  Конфигурация и выделенные ресурсы для хостов mongos 3.6.

                                                  Mongod

                                                  Поле Описание
                                                  config config.MongodConfig3_6
                                                  Конфигурация для хостов mongod 3.6.
                                                  resources Resources
                                                  Ресурсы, выделенные каждому хосту mongod.

                                                  MongoCfg

                                                  Поле Описание
                                                  config config.MongoCfgConfig3_6
                                                  Конфигурация для хостов mongocfg 3.6.
                                                  resources Resources
                                                  Ресурсы, выделенные для каждого хоста mongocfg.

                                                  Mongos

                                                  Поле Описание
                                                  config config.MongosConfig3_6
                                                  Конфигурация для хостов mongos 3.6.
                                                  resources Resources
                                                  Ресурсы, выделенные для каждого хоста mongos.

                                                  MongodbSpec4_0

                                                  Поле Описание
                                                  mongod Mongod
                                                  Конфигурация и выделенные ресурсы для хостов mongod 4.0.
                                                  mongocfg MongoCfg
                                                  Конфигурация и выделенные ресурсы для хостов mongocfg 4.0.
                                                  mongos Mongos
                                                  Конфигурация и выделенные ресурсы для хостов mongos 4.0.

                                                  Mongod

                                                  Поле Описание
                                                  config config.MongodConfig4_0
                                                  Конфигурация для хостов mongod 4.0.
                                                  resources Resources
                                                  Ресурсы, выделенные каждому хосту mongod.

                                                  MongoCfg

                                                  Поле Описание
                                                  config config.MongoCfgConfig4_0
                                                  Конфигурация для хостов mongocfg 4.0.
                                                  resources Resources
                                                  Ресурсы, выделенные для каждого хоста mongocfg.

                                                  Mongos

                                                  Поле Описание
                                                  config config.MongosConfig4_0
                                                  Конфигурация для хостов mongos 4.0.
                                                  resources Resources
                                                  Ресурсы, выделенные для каждого хоста mongos.

                                                  HostSpec

                                                  Поле Описание
                                                  zone_id string
                                                  Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List. Максимальная длина строки в символах — 50.
                                                  subnet_id string
                                                  Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети устанавливается в поле Cluster.network_id. Максимальная длина строки в символах — 50.
                                                  assign_public_ip bool
                                                  • false — не назначать хосту публичный IP-адрес.
                                                  • true — у хоста должен быть публичный IP-адрес.
                                                  type Host.Type
                                                  Тип развертываемого хоста.
                                                  shard_name string
                                                  Имя шарда, которому принадлежит хост. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

                                                  Operation

                                                  Поле Описание
                                                  id string
                                                  Идентификатор операции.
                                                  description string
                                                  Описание операции. Длина описания должна быть от 0 до 256 символов.
                                                  created_at google.protobuf.Timestamp
                                                  Время создания ресурса в формате в RFC3339.
                                                  created_by string
                                                  Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                                  modified_at google.protobuf.Timestamp
                                                  Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                                  done bool
                                                  Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                                  metadata google.protobuf.Any<RestoreClusterMetadata>
                                                  Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                                  result oneof: error или response
                                                  Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                                    error google.rpc.Status
                                                  Описание ошибки в случае сбоя или отмены операции.
                                                    response google.protobuf.Any<Cluster>
                                                  в случае успешного выполнения операции.

                                                  RestoreClusterMetadata

                                                  Поле Описание
                                                  cluster_id string
                                                  Идентификатор нового кластера MongoDB, создаваемого из резервной копии.
                                                  backup_id string
                                                  Идентификатор резервной копии, используемой для создания кластера.

                                                  Cluster

                                                  Поле Описание
                                                  id string
                                                  Идентификатор кластера MongoDB. Этот идентификатор генерирует MDB при создании.
                                                  folder_id string
                                                  Идентификатор каталога, которому принадлежит кластер MongoDB.
                                                  created_at google.protobuf.Timestamp
                                                  Время создания в формате RFC3339 .
                                                  name string
                                                  Имя кластера MongoDB. Имя уникально в рамках каталога. Длина 1-63 символов.
                                                  description string
                                                  Описание кластера MongoDB. Длина описания должна быть от 0 до 256 символов.
                                                  labels map<string,string>
                                                  Пользовательские метки для кластера MongoDB как пары key:value. Максимум 64 на ресурс.
                                                  environment enum Environment
                                                  Среда развертывания кластера MongoDB.
                                                  • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
                                                  • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
                                                    monitoring[] Monitoring
                                                    Описание систем мониторинга, относящихся к данному кластеру MongoDB.
                                                    config ClusterConfig
                                                    Конфигурация кластера MongoDB.
                                                    network_id string
                                                    Идентификатор сети, к которой принадлежит кластер.
                                                    health enum Health
                                                    Агрегированная работоспособность кластера.
                                                    • HEALTH_UNKNOWN: Состояние кластера неизвестно (Host.health для каждого хоста в кластере — UNKNOWN).
                                                    • ALIVE: Кластер работает нормально (Host.health для каждого хоста в кластере — ALIVE).
                                                    • DEAD: Кластер не работает (Host.health для каждого узла в кластере — DEAD).
                                                    • DEGRADED: Кластер работает неоптимально (Host.health по крайней мере для одного узла в кластере не ALIVE).
                                                      status enum Status
                                                      Текущее состояние кластера.
                                                      • STATUS_UNKNOWN: Состояние кластера неизвестно.
                                                      • CREATING: Кластер создается.
                                                      • RUNNING: Кластер работает нормально.
                                                      • ERROR: На кластере произошла ошибка, блокирующая работу.
                                                      • UPDATING: Кластер изменяется.
                                                      • STOPPING: Кластер останавливается.
                                                      • STOPPED: Кластер остановлен.
                                                      • STARTING: Кластер запускается.
                                                        sharded bool
                                                        Указывает текущее состояние шардирования кластера.

                                                        ListLogs

                                                        Получает логи для указанного кластера MongoDB.

                                                        rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)

                                                        ListClusterLogsRequest

                                                        Поле Описание
                                                        cluster_id string
                                                        Обязательное поле. Идентификатор кластера MongoDB, для которого следует запросить логи. Чтобы получить идентификатор кластера MongoDB, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                        column_filter[] string
                                                        Столбцы из таблицы логов для запроса. Если столбцы не указаны, записи логов возвращаются целиком.
                                                        service_type enum ServiceType
                                                        Тип сервиса, для которого следует запросить логи.
                                                        • MONGOD: Логи работы MongoDB.
                                                          from_time google.protobuf.Timestamp
                                                          Начало периода, для которого следует запросить логи, в формате RFC3339.
                                                          to_time google.protobuf.Timestamp
                                                          Конец периода, для которого следует запросить логи, в формате RFC3339.
                                                          page_size int64
                                                          Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListClusterLogsResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
                                                          page_token string
                                                          Токен страницы. Установите значение page_token равным значению поля ListClusterLogsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

                                                          ListClusterLogsResponse

                                                          Поле Описание
                                                          logs[] LogRecord
                                                          Запрошенные записи логов.
                                                          next_page_token string
                                                          Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClusterLogsRequest.page_size, используйте next_page_token в качестве значения параметра ListClusterLogsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

                                                          LogRecord

                                                          Поле Описание
                                                          timestamp google.protobuf.Timestamp
                                                          Отметка времени для записи журнала в RFC3339 текстовом формате.
                                                          message map<string,string>
                                                          Содержание записи журнала.

                                                          ListOperations

                                                          Получает список ресурсов Operation для указанного кластера.

                                                          rpc ListOperations (ListClusterOperationsRequest) returns (ListClusterOperationsResponse)

                                                          ListClusterOperationsRequest

                                                          Поле Описание
                                                          cluster_id string
                                                          Обязательное поле. Идентификатор ресурса Cluster для MongoDB, для которого запрашивается список операций. Максимальная длина строки в символах — 50.
                                                          page_size int64
                                                          Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListClusterOperationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
                                                          page_token string
                                                          Токен страницы. Установите значение page_token равным значению поля ListClusterOperationsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

                                                          ListClusterOperationsResponse

                                                          Поле Описание
                                                          operations[] operation.Operation
                                                          Список ресурсов Operation для указанного кластера MongoDB.
                                                          next_page_token string
                                                          Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClusterOperationsRequest.page_size, используйте next_page_token в качестве значения параметра ListClusterOperationsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

                                                          Operation

                                                          Поле Описание
                                                          id string
                                                          Идентификатор операции.
                                                          description string
                                                          Описание операции. Длина описания должна быть от 0 до 256 символов.
                                                          created_at google.protobuf.Timestamp
                                                          Время создания ресурса в формате в RFC3339.
                                                          created_by string
                                                          Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                                          modified_at google.protobuf.Timestamp
                                                          Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                                          done bool
                                                          Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                                          metadata google.protobuf.Any
                                                          Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                                          result oneof: error или response
                                                          Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                                            error google.rpc.Status
                                                          Описание ошибки в случае сбоя или отмены операции.
                                                            response google.protobuf.Any
                                                          Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.

                                                          ListBackups

                                                          Получает список доступных резервных копий для указанного кластера MongoDB.

                                                          rpc ListBackups (ListClusterBackupsRequest) returns (ListClusterBackupsResponse)

                                                          ListClusterBackupsRequest

                                                          Поле Описание
                                                          cluster_id string
                                                          Обязательное поле. Идентификатор кластера MongoDB. Чтобы получить идентификатор кластера MongoDB, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                          page_size int64
                                                          Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListClusterBackupsResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
                                                          page_token string
                                                          Токен страницы. Установите значение page_token равным значению поля ListClusterBackupsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

                                                          ListClusterBackupsResponse

                                                          Поле Описание
                                                          backups[] Backup
                                                          Список ресурсов Backup для MongoDB.
                                                          next_page_token string
                                                          Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClusterBackupsRequest.page_size, используйте next_page_token в качестве значения параметра ListClusterBackupsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

                                                          Backup

                                                          Поле Описание
                                                          id string
                                                          Идентификатор резервной копии.
                                                          folder_id string
                                                          Идентификатор каталога, которому принадлежит резервная копия.
                                                          created_at google.protobuf.Timestamp
                                                          Время создания в формате RFC3339 (т. е. когда операция резервного копирования была завершена).
                                                          source_cluster_id string
                                                          Идентификатор кластера MongoDB, для которого была создана резервная копия.
                                                          started_at google.protobuf.Timestamp
                                                          Время запуска операции резервного копирования.
                                                          source_shard_names[] string
                                                          Имена шардов, которые использовались при создании резервной копии.

                                                          ListHosts

                                                          Получает список хостов для указанного кластера.

                                                          rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)

                                                          ListClusterHostsRequest

                                                          Поле Описание
                                                          cluster_id string
                                                          Обязательное поле. Идентификатор кластера MongoDB. Чтобы получить идентификатор кластера MongoDB, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                          page_size int64
                                                          Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListClusterHostsResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
                                                          page_token string
                                                          Токен страницы. Установите значение page_token равным значению поля ListClusterHostsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

                                                          ListClusterHostsResponse

                                                          Поле Описание
                                                          hosts[] Host
                                                          Список ресурсов Host.
                                                          next_page_token string
                                                          Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClusterHostsRequest.page_size, используйте next_page_token в качестве значения параметра ListClusterHostsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

                                                          Host

                                                          Поле Описание
                                                          name string
                                                          Имя хоста MongoDB. Имя хоста назначается MDB во время создания и не может быть изменено. Длина 1-63 символов.
                                                          Имя уникально для всех существующих хостов MDB в Яндекс.Облаке, так как оно определяет полное доменное имя (FQDN) хоста.
                                                          cluster_id string
                                                          Идентификатор хоста MongoDB. Этот идентификатор генерирует MDB при создании.
                                                          zone_id string
                                                          Идентификатор зоны доступности, в которой находится хост MongoDB.
                                                          resources Resources
                                                          Ресурсы, выделенные хосту MongoDB.
                                                          role enum Role
                                                          Роль хоста в кластере.
                                                          • ROLE_UNKNOWN: Роль хоста в кластере неизвестна.
                                                          • PRIMARY: Хост является основным сервером MongoDB в кластере.
                                                          • SECONDARY: Хост является вторичным сервером MongoDB в кластере.
                                                            health enum Health
                                                            Код работоспособности хоста.
                                                            • HEALTH_UNKNOWN: Состояние хоста неизвестно.
                                                            • ALIVE: Хозяин выполняет все свои функции нормально.
                                                            • DEAD: Хост не работает и не может выполнять свои основные функции.
                                                            • DEGRADED: Хост деградировал, и может выполнять только некоторые из своих основных функций.
                                                              services[] Service
                                                              Сервисы, предоставляемые хостом.
                                                              subnet_id string
                                                              Идентификатор подсети, к которой принадлежит хост.
                                                              assign_public_ip bool
                                                              Флаг, показывающий статус публичного IP-адреса для этого хоста.
                                                              shard_name string
                                                              Шард, которому принадлежит этот этот хост.
                                                              type enum Type
                                                              Тип хоста
                                                              • MONGOD: Хост mongod.
                                                              • MONGOS: Хост mongos.
                                                              • MONGOCFG: Хост mongocfg.

                                                                Resources

                                                                Поле Описание
                                                                resource_preset_id string
                                                                Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
                                                                disk_size int64
                                                                Объем хранилища, доступного хосту, в байтах.
                                                                disk_type_id string
                                                                • network-hdd — сетевой HDD-диск;
                                                                • network-ssd — сетевой SSD-диск;
                                                                • local-ssd — локальное SSD-хранилище.

                                                                Service

                                                                Поле Описание
                                                                type enum Type
                                                                Тип сервиса, предоставляемого хостом.
                                                                • MONGOD: На хосте работает демон mongod.
                                                                • MONGOS: На хосте работает демон mongos.
                                                                • MONGOCFG: На хосте работает сервер конфигураций MongoDB.
                                                                  health enum Health
                                                                  Код состояния доступности сервера.
                                                                  • HEALTH_UNKNOWN: Работоспособность сервера неизвестна.
                                                                  • ALIVE: Сервер работает нормально.
                                                                  • DEAD: Сервер отключен или не отвечает.

                                                                    AddHosts

                                                                    Создает новые хосты для кластера.

                                                                    rpc AddHosts (AddClusterHostsRequest) returns (operation.Operation)

                                                                    Метаданные и результат операции:

                                                                        Operation.metadata:AddClusterHostsMetadata

                                                                        Operation.response:google.protobuf.Empty

                                                                    AddClusterHostsRequest

                                                                    Поле Описание
                                                                    cluster_id string
                                                                    Обязательное поле. Идентификатор кластера MongoDB, для которого следует добавить хосты. Чтобы получить идентификатор кластера MongoDB, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                                    host_specs[] HostSpec
                                                                    Конфигурации для хостов MongoDB, которые должны быть добавлены в кластер. Количество элементов должно быть больше 0.

                                                                    HostSpec

                                                                    Поле Описание
                                                                    zone_id string
                                                                    Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List. Максимальная длина строки в символах — 50.
                                                                    subnet_id string
                                                                    Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети устанавливается в поле Cluster.network_id. Максимальная длина строки в символах — 50.
                                                                    assign_public_ip bool
                                                                    • false — не назначать хосту публичный IP-адрес.
                                                                    • true — у хоста должен быть публичный IP-адрес.
                                                                    type Host.Type
                                                                    Тип развертываемого хоста.
                                                                    shard_name string
                                                                    Имя шарда, которому принадлежит хост. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

                                                                    Operation

                                                                    Поле Описание
                                                                    id string
                                                                    Идентификатор операции.
                                                                    description string
                                                                    Описание операции. Длина описания должна быть от 0 до 256 символов.
                                                                    created_at google.protobuf.Timestamp
                                                                    Время создания ресурса в формате в RFC3339.
                                                                    created_by string
                                                                    Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                                                    modified_at google.protobuf.Timestamp
                                                                    Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                                                    done bool
                                                                    Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                                                    metadata google.protobuf.Any<AddClusterHostsMetadata>
                                                                    Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                                                    result oneof: error или response
                                                                    Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                                                      error google.rpc.Status
                                                                    Описание ошибки в случае сбоя или отмены операции.
                                                                      response google.protobuf.Any<google.protobuf.Empty>
                                                                    в случае успешного выполнения операции.

                                                                    AddClusterHostsMetadata

                                                                    Поле Описание
                                                                    cluster_id string
                                                                    Идентификатор кластера MongoDB, в который добавляются хосты.
                                                                    host_names[] string
                                                                    Имена хостов, добавляемых в кластер.

                                                                    DeleteHosts

                                                                    Удаляет указанные хосты кластера.

                                                                    rpc DeleteHosts (DeleteClusterHostsRequest) returns (operation.Operation)

                                                                    Метаданные и результат операции:

                                                                        Operation.metadata:DeleteClusterHostsMetadata

                                                                        Operation.response:google.protobuf.Empty

                                                                    DeleteClusterHostsRequest

                                                                    Поле Описание
                                                                    cluster_id string
                                                                    Обязательное поле. Идентификатор кластера MongoDB, из которого следует удалить хосты. Чтобы получить идентификатор кластера MongoDB, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                                    host_names[] string
                                                                    Имена хостов, которые следует удалить. Количество элементов должно быть больше 0. Максимальная длина строки в символах для каждого значения — 253.

                                                                    Operation

                                                                    Поле Описание
                                                                    id string
                                                                    Идентификатор операции.
                                                                    description string
                                                                    Описание операции. Длина описания должна быть от 0 до 256 символов.
                                                                    created_at google.protobuf.Timestamp
                                                                    Время создания ресурса в формате в RFC3339.
                                                                    created_by string
                                                                    Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                                                    modified_at google.protobuf.Timestamp
                                                                    Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                                                    done bool
                                                                    Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                                                    metadata google.protobuf.Any<DeleteClusterHostsMetadata>
                                                                    Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                                                    result oneof: error или response
                                                                    Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                                                      error google.rpc.Status
                                                                    Описание ошибки в случае сбоя или отмены операции.
                                                                      response google.protobuf.Any<google.protobuf.Empty>
                                                                    в случае успешного выполнения операции.

                                                                    DeleteClusterHostsMetadata

                                                                    Поле Описание
                                                                    cluster_id string
                                                                    Идентификатор кластера MongoDB, из которого следует удалить хосты.
                                                                    host_names[] string
                                                                    Имена удаляемых хостов.

                                                                    EnableSharding

                                                                    Включает шардирование для кластера: создает 3 хоста mongocfg и 2 хоста mongos, которые необходимы чтобы добавлять и использовать шарды в кластере.

                                                                    rpc EnableSharding (EnableClusterShardingRequest) returns (operation.Operation)

                                                                    Метаданные и результат операции:

                                                                        Operation.metadata:EnableClusterShardingMetadata

                                                                        Operation.response:google.protobuf.Empty

                                                                    EnableClusterShardingRequest

                                                                    Поле Описание
                                                                    cluster_id string
                                                                    Обязательное поле. Идентификатор кластера MongoDB, для которого нужно включить шардирование. Максимальная длина строки в символах — 50.
                                                                    mongocfg MongoCfg
                                                                    Обязательное поле. Спецификация mongocfg для шардирования.
                                                                    mongos Mongos
                                                                    Обязательное поле. Спецификация mongos для шардирования.
                                                                    host_specs[] HostSpec
                                                                    Конфигурации для хостов mongos и mongocfg. Количество элементов должно быть больше 0.

                                                                    MongoCfg

                                                                    Поле Описание
                                                                    resources Resources
                                                                    Обязательное поле. Ресурсы для хостов mongocfg.

                                                                    Mongos

                                                                    Поле Описание
                                                                    resources Resources
                                                                    Обязательное поле. Ресурсы для хостов mongos.

                                                                    HostSpec

                                                                    Поле Описание
                                                                    zone_id string
                                                                    Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List. Максимальная длина строки в символах — 50.
                                                                    subnet_id string
                                                                    Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети устанавливается в поле Cluster.network_id. Максимальная длина строки в символах — 50.
                                                                    assign_public_ip bool
                                                                    • false — не назначать хосту публичный IP-адрес.
                                                                    • true — у хоста должен быть публичный IP-адрес.
                                                                    type Host.Type
                                                                    Тип развертываемого хоста.
                                                                    shard_name string
                                                                    Имя шарда, которому принадлежит хост. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

                                                                    Operation

                                                                    Поле Описание
                                                                    id string
                                                                    Идентификатор операции.
                                                                    description string
                                                                    Описание операции. Длина описания должна быть от 0 до 256 символов.
                                                                    created_at google.protobuf.Timestamp
                                                                    Время создания ресурса в формате в RFC3339.
                                                                    created_by string
                                                                    Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                                                    modified_at google.protobuf.Timestamp
                                                                    Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                                                    done bool
                                                                    Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                                                    metadata google.protobuf.Any<EnableClusterShardingMetadata>
                                                                    Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                                                    result oneof: error или response
                                                                    Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                                                      error google.rpc.Status
                                                                    Описание ошибки в случае сбоя или отмены операции.
                                                                      response google.protobuf.Any<google.protobuf.Empty>
                                                                    в случае успешного выполнения операции.

                                                                    EnableClusterShardingMetadata

                                                                    Поле Описание
                                                                    cluster_id string
                                                                    Идентификатор кластера MongoDB, для которого включается шардирование.

                                                                    GetShard

                                                                    Возвращает указанный шард.

                                                                    rpc GetShard (GetClusterShardRequest) returns (Shard)

                                                                    GetClusterShardRequest

                                                                    Поле Описание
                                                                    cluster_id string
                                                                    Обязательное поле. Идентификатор MongoDB-кластера, которому принадлежит шард. Чтобы получить идентификатор кластера, используйте запрос List. Максимальная длина строки в символах — 50.
                                                                    shard_name string
                                                                    Обязательное поле. Имя запрашиваемого шарда MongoDB. Чтобы получить имя шарда, используйте запрос ListShards. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

                                                                    Shard

                                                                    Поле Описание
                                                                    name string
                                                                    Имя шарда.
                                                                    cluster_id string
                                                                    Идентификатор кластера, к которому принадлежит шард.

                                                                    ListShards

                                                                    Получает список шардов.

                                                                    rpc ListShards (ListClusterShardsRequest) returns (ListClusterShardsResponse)

                                                                    ListClusterShardsRequest

                                                                    Поле Описание
                                                                    cluster_id string
                                                                    Обязательное поле. Идентификатор кластера MongoDB, для которого следует вернуть список баз данных. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                                    page_size int64
                                                                    Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListClusterShardsResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
                                                                    page_token string
                                                                    Токен страницы. Установите значение page_token равным значению поля ListClusterShardsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

                                                                    ListClusterShardsResponse

                                                                    Поле Описание
                                                                    shards[] Shard
                                                                    Список шардов MongoDB.
                                                                    next_page_token string
                                                                    Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClusterShardsRequest.page_size, используйте next_page_token в качестве значения параметра ListClusterShardsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов.

                                                                    Shard

                                                                    Поле Описание
                                                                    name string
                                                                    Имя шарда.
                                                                    cluster_id string
                                                                    Идентификатор кластера, к которому принадлежит шард.

                                                                    AddShard

                                                                    Создает новый шард.

                                                                    rpc AddShard (AddClusterShardRequest) returns (operation.Operation)

                                                                    Метаданные и результат операции:

                                                                        Operation.metadata:AddClusterShardMetadata

                                                                        Operation.response:Shard

                                                                    AddClusterShardRequest

                                                                    Поле Описание
                                                                    cluster_id string
                                                                    Обязательное поле. Идентификатор кластера MongoDB, в который нужно добавить шард. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                                    shard_name string
                                                                    Обязательное поле. Имя создаваемого шарда MongoDB. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.
                                                                    host_specs[] HostSpec
                                                                    Конфигурации для хостов mongod, которые будут созданы вместе с шардом. Количество элементов должно быть больше 0.

                                                                    HostSpec

                                                                    Поле Описание
                                                                    zone_id string
                                                                    Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List. Максимальная длина строки в символах — 50.
                                                                    subnet_id string
                                                                    Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети устанавливается в поле Cluster.network_id. Максимальная длина строки в символах — 50.
                                                                    assign_public_ip bool
                                                                    • false — не назначать хосту публичный IP-адрес.
                                                                    • true — у хоста должен быть публичный IP-адрес.
                                                                    type Host.Type
                                                                    Тип развертываемого хоста.
                                                                    shard_name string
                                                                    Имя шарда, которому принадлежит хост. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

                                                                    Operation

                                                                    Поле Описание
                                                                    id string
                                                                    Идентификатор операции.
                                                                    description string
                                                                    Описание операции. Длина описания должна быть от 0 до 256 символов.
                                                                    created_at google.protobuf.Timestamp
                                                                    Время создания ресурса в формате в RFC3339.
                                                                    created_by string
                                                                    Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                                                    modified_at google.protobuf.Timestamp
                                                                    Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                                                    done bool
                                                                    Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                                                    metadata google.protobuf.Any<AddClusterShardMetadata>
                                                                    Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                                                    result oneof: error или response
                                                                    Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                                                      error google.rpc.Status
                                                                    Описание ошибки в случае сбоя или отмены операции.
                                                                      response google.protobuf.Any<Shard>
                                                                    в случае успешного выполнения операции.

                                                                    AddClusterShardMetadata

                                                                    Поле Описание
                                                                    cluster_id string
                                                                    Идентификатор кластера MongoDB, в который добавляется шард.
                                                                    shard_name string
                                                                    Имя добавляемого шарда.

                                                                    Shard

                                                                    Поле Описание
                                                                    name string
                                                                    Имя шарда.
                                                                    cluster_id string
                                                                    Идентификатор кластера, к которому принадлежит шард.

                                                                    DeleteShard

                                                                    Удаляет указанный шард.

                                                                    rpc DeleteShard (DeleteClusterShardRequest) returns (operation.Operation)

                                                                    Метаданные и результат операции:

                                                                        Operation.metadata:DeleteClusterShardMetadata

                                                                        Operation.response:google.protobuf.Empty

                                                                    DeleteClusterShardRequest

                                                                    Поле Описание
                                                                    cluster_id string
                                                                    Обязательное поле. Идентификатор кластера MongoDB, в котором следует удалить шард. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
                                                                    shard_name string
                                                                    Обязательное поле. Имя шарда MongoDB, который следует удалить. Чтобы получить имя шарда, используйте запрос ListShards. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

                                                                    Operation

                                                                    Поле Описание
                                                                    id string
                                                                    Идентификатор операции.
                                                                    description string
                                                                    Описание операции. Длина описания должна быть от 0 до 256 символов.
                                                                    created_at google.protobuf.Timestamp
                                                                    Время создания ресурса в формате в RFC3339.
                                                                    created_by string
                                                                    Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
                                                                    modified_at google.protobuf.Timestamp
                                                                    Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
                                                                    done bool
                                                                    Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
                                                                    metadata google.protobuf.Any<DeleteClusterShardMetadata>
                                                                    Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
                                                                    result oneof: error или response
                                                                    Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
                                                                      error google.rpc.Status
                                                                    Описание ошибки в случае сбоя или отмены операции.
                                                                      response google.protobuf.Any<google.protobuf.Empty>
                                                                    в случае успешного выполнения операции.

                                                                    DeleteClusterShardMetadata

                                                                    Поле Описание
                                                                    cluster_id string
                                                                    Идентификатор кластера MongoDB, в котором удаляется шард.
                                                                    shard_name string
                                                                    Имя удаляемого шарда.