DatabaseService

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

Вызов Описание
Get Возвращает указанный ресурс Database для MongoDB.
List Получает список ресурсов Database для указанного кластера MongoDB.
Create Создает новую базу данных MongoDB в указанном кластере.
Delete Удаляет указанную базу данных MongoDB.

Вызовы DatabaseService

Get

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

rpc Get (GetDatabaseRequest) returns (Database)

GetDatabaseRequest

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

Database

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

List

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

rpc List (ListDatabasesRequest) returns (ListDatabasesResponse)

ListDatabasesRequest

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

ListDatabasesResponse

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

Database

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

Create

Создает новую базу данных MongoDB в указанном кластере.

rpc Create (CreateDatabaseRequest) returns (operation.Operation)

Метаданные и результат операции:
    Operation.metadata:CreateDatabaseMetadata
    Operation.response:Database

CreateDatabaseRequest

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

DatabaseSpec

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

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<CreateDatabaseMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Database>
в случае успешного выполнения операции.

CreateDatabaseMetadata

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

Database

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

Delete

Удаляет указанную базу данных MongoDB.

rpc Delete (DeleteDatabaseRequest) returns (operation.Operation)

Метаданные и результат операции:
    Operation.metadata:DeleteDatabaseMetadata
    Operation.response:google.protobuf.Empty

DeleteDatabaseRequest

Поле Описание
cluster_id string
Обязательное поле. Идентификатор кластера MongoDB, в котором следует удалить базу данных. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50.
database_name string
Обязательное поле. Имя удаляемой базы данных. Чтобы получить имя базы данных, используйте запрос DatabaseService.List. Максимальная длина строки в символах — 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<DeleteDatabaseMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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>
в случае успешного выполнения операции.

DeleteDatabaseMetadata

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