ClusterService
Набор методов для управления ресурсами Cluster для PostgreSQL.
Вызов | Описание |
---|---|
Get | Возвращает указанный ресурс Cluster для PostgreSQL. |
List | Получает список ресурсов Cluster для PostgreSQL, принадлежащих указанному каталогу. |
Create | Создает кластер PostgreSQL в указанном каталоге. |
Update | Изменяет указанный кластер PostgreSQL. |
Delete | Удаляет указанный кластер PostgreSQL. |
Start | Запускает указанный кластер PostgreSQL. |
Stop | Останавливает указанный кластер PostgreSQL. |
Move | Перемещает кластер PostgreSQL в указанный каталог. |
Backup | Создает резервную копию для указанного кластера PostgreSQL. |
Restore | Создает новый кластер PostgreSQL с использованием указанной резервной копии. |
StartFailover | Запускает ручное переключение мастера для указанного кластера PostgreSQL. |
ListLogs | Получает логи для указанного кластера PostgreSQL. |
ListOperations | Получает список ресурсов Operation для указанного кластера. |
ListBackups | Получает список доступных резервных копий для указанного кластера PostgreSQL. |
ListHosts | Получает список хостов для указанного кластера. |
AddHosts | Создает новые хосты для кластера. |
DeleteHosts | Удаляет указанные хосты кластера. |
UpdateHosts | Обновляет указанные хосты. |
Вызовы ClusterService
Get
Возвращает указанный ресурс Cluster для PostgreSQL.
Чтобы получить список доступных ресурсов Cluster для PostgreSQL, отправьте запрос List.
rpc Get (GetClusterRequest) returns (Cluster)
GetClusterRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор возвращаемого ресурса Cluster для PostgreSQL. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера PostgreSQL. Этот идентификатор генерирует MDB при создании. |
folder_id | string Идентификатор каталога, которому принадлежит кластер PostgreSQL. |
created_at | google.protobuf.Timestamp Время создания в формате RFC3339 . |
name | string Имя кластера PostgreSQL. Имя уникально в рамках каталога. Длина 1-63 символов. |
description | string Описание кластера PostgreSQL. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера PostgreSQL в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания для кластера PostgreSQL.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру PostgreSQL. |
config | ClusterConfig Конфигурация кластера PostgreSQL. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Агрегированная работоспособность кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для данного кластера PostgreSQL. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения PostgreSQL. |
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 или postgresql_config_12_1c Конфигурация для серверов PostgreSQL в кластере. |
postgresql_config_9_6 | PostgresqlConfigSet9_6 Конфигурация сервера PostgreSQL 9.6. |
postgresql_config_10_1c | PostgresqlConfigSet10_1C Конфигурация сервера PostgreSQL 10 1С. |
postgresql_config_10 | PostgresqlConfigSet10 Конфигурация сервера PostgreSQL 10. |
postgresql_config_11 | PostgresqlConfigSet11 Конфигурация сервера PostgreSQL 11. |
postgresql_config_11_1c | config.PostgresqlConfigSet11_1C Конфигурация сервера PostgreSQL 11 1C. |
postgresql_config_12 | PostgresqlConfigSet12 Конфигурация сервера PostgreSQL 12. |
postgresql_config_12_1c | config.PostgresqlConfigSet12_1C Конфигурация сервера PostgreSQL 12 1C. |
pooler_config | ConnectionPoolerConfig Конфигурация менеджера соединений. |
resources | Resources Ресурсы, выделенные хостам PostgreSQL. |
autofailover | google.protobuf.BoolValue Параметр конфигурации, который включает / отключает автоматическое переключение мастера в кластере. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
ConnectionPoolerConfig
Поле | Описание |
---|---|
pooling_mode | enum PoolingMode Режим, в котором работает менеджер подключений. См. описание всех режимов в документации PgBouncer.
|
pool_discard | google.protobuf.BoolValue Установка параметра server_reset_query_always в PgBouncer. |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту, в байтах. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
List
Получает список ресурсов Cluster для PostgreSQL, принадлежащих указанному каталогу.
rpc List (ListClustersRequest) returns (ListClustersResponse)
ListClustersRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога для вывода списка кластеров PostgreSQL. Чтобы получить идентификатор каталога, используйте запрос 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
|
ListClustersResponse
Поле | Описание |
---|---|
clusters[] | Cluster Список ресурсов Cluster для PostgreSQL. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClustersRequest.page_size, используйте next_page_token в качестве значения параметра ListClustersRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера PostgreSQL. Этот идентификатор генерирует MDB при создании. |
folder_id | string Идентификатор каталога, которому принадлежит кластер PostgreSQL. |
created_at | google.protobuf.Timestamp Время создания в формате RFC3339 . |
name | string Имя кластера PostgreSQL. Имя уникально в рамках каталога. Длина 1-63 символов. |
description | string Описание кластера PostgreSQL. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера PostgreSQL в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания для кластера PostgreSQL.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру PostgreSQL. |
config | ClusterConfig Конфигурация кластера PostgreSQL. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Агрегированная работоспособность кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для данного кластера PostgreSQL. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения PostgreSQL. |
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 или postgresql_config_12_1c Конфигурация для серверов PostgreSQL в кластере. |
postgresql_config_9_6 | PostgresqlConfigSet9_6 Конфигурация сервера PostgreSQL 9.6. |
postgresql_config_10_1c | PostgresqlConfigSet10_1C Конфигурация сервера PostgreSQL 10 1С. |
postgresql_config_10 | PostgresqlConfigSet10 Конфигурация сервера PostgreSQL 10. |
postgresql_config_11 | PostgresqlConfigSet11 Конфигурация сервера PostgreSQL 11. |
postgresql_config_11_1c | config.PostgresqlConfigSet11_1C Конфигурация сервера PostgreSQL 11 1C. |
postgresql_config_12 | PostgresqlConfigSet12 Конфигурация сервера PostgreSQL 12. |
postgresql_config_12_1c | config.PostgresqlConfigSet12_1C Конфигурация сервера PostgreSQL 12 1C. |
pooler_config | ConnectionPoolerConfig Конфигурация менеджера соединений. |
resources | Resources Ресурсы, выделенные хостам PostgreSQL. |
autofailover | google.protobuf.BoolValue Параметр конфигурации, который включает / отключает автоматическое переключение мастера в кластере. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
ConnectionPoolerConfig
Поле | Описание |
---|---|
pooling_mode | enum PoolingMode Режим, в котором работает менеджер подключений. См. описание всех режимов в документации PgBouncer.
|
pool_discard | google.protobuf.BoolValue Установка параметра server_reset_query_always в PgBouncer. |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту, в байтах. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
Create
Создает кластер PostgreSQL в указанном каталоге.
rpc Create (CreateClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:CreateClusterMetadata
Operation.response:Cluster
CreateClusterRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога, в котором нужно создать кластер PostgreSQL. Максимальная длина строки в символах — 50. |
name | string Обязательное поле. Имя кластера PostgreSQL. Имя должно быть уникальным в каталоге. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]* . |
description | string Описание кластера PostgreSQL. Максимальная длина строки в символах — 256. |
labels | map<string,string> Пользовательские метки для кластера PostgreSQL в виде пар key:value . Не больше 64 меток на ресурс. Например, "project": "mvp" или "source": "dictionary". Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Максимальная длина строки в символах для каждого ключа — 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
environment | Cluster.Environment Обязательное поле. Среда развертывания для кластера PostgreSQL. |
config_spec | ConfigSpec Обязательное поле. Конфигурация и ресурсы для хостов, которые должны быть созданы для кластера PostgreSQL. |
database_specs[] | DatabaseSpec Обязательное поле. Описания баз данных, которые нужно создать в кластере PostgreSQL. |
user_specs[] | UserSpec Обязательное поле. Описания пользователей базы данных, которых нужно создать в кластере PostgreSQL. |
host_specs[] | HostSpec Обязательное поле. Конфигурации для отдельных хостов, которые должны быть созданы для кластера PostgreSQL. |
network_id | string Обязательное поле. Идентификатор сети, в которой нужно создать кластер. Максимальная длина строки в символах — 50. |
ConfigSpec
Поле | Описание |
---|---|
version | string Версия PostgreSQL, используемая в кластере. Возможные значения 9.6 , 10 , 10_1c , 11 , 12 . |
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 или postgresql_config_12_1c Конфигурация кластера PostgreSQL. |
postgresql_config_9_6 | PostgresqlConfig9_6 Конфигурация для кластера PostgreSQL 9.6. |
postgresql_config_10_1c | PostgresqlConfig10_1C Конфигурация для кластера PostgreSQL 10. |
postgresql_config_10 | PostgresqlConfig10 Конфигурация для кластера PostgreSQL 10. |
postgresql_config_11 | PostgresqlConfig11 Конфигурация для кластера PostgreSQL 11. |
postgresql_config_11_1c | config.PostgresqlConfig11_1C Конфигурация для кластера PostgreSQL 11 1C. |
postgresql_config_12 | PostgresqlConfig12 Конфигурация для кластера PostgreSQL 12. |
postgresql_config_12_1c | config.PostgresqlConfig12_1C Конфигурация для кластера PostgreSQL 12 1C. |
pooler_config | ConnectionPoolerConfig Конфигурация менеджера соединений. |
resources | Resources Ресурсы, выделенные хостам PostgreSQL. |
autofailover | google.protobuf.BoolValue Параметр конфигурации, который включает / отключает автоматическое переключение мастера в кластере. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
ConnectionPoolerConfig
Поле | Описание |
---|---|
pooling_mode | enum PoolingMode Режим, в котором работает менеджер подключений. См. описание всех режимов в документации PgBouncer.
|
pool_discard | google.protobuf.BoolValue Установка параметра server_reset_query_always в PgBouncer. |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту, в байтах. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
DatabaseSpec
Поле | Описание |
---|---|
name | string Обязательное поле. Имя базы данных PostgreSQL. Длина 1-63 символов. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]* . |
owner | string Обязательное поле. Имя пользователя, которого нужно назначить владельцем базы данных. Чтобы получить список доступных пользователей PostgreSQL, сделайте запрос UserService.List. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]* . |
lc_collate | string POSIX-локаль для порядка сортировки строк. Может быть установлен только во время создания. Значение должно соответствовать регулярному выражению |[a-zA-Z_]+.UTF-8|C . |
lc_ctype | string POSIX-локаль для классификации символов. Может быть установлена только во время создания. Значение должно соответствовать регулярному выражению |[a-zA-Z_]+.UTF-8|C . |
extensions[] | Extension Расширения PostgreSQL, которые следует подключить для базы данных. |
Extension
Поле | Описание |
---|---|
name | string Имя расширения, например pg_trgm или pg_btree . Расширения, которые поддерживает Managed Service for PostgreSQL, перечислены в документации. |
version | string Версия расширения. |
UserSpec
Поле | Описание |
---|---|
name | string Обязательное поле. Имя пользователя PostgreSQL. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]* . |
password | string Обязательное поле. Пароль пользователя PostgreSQL. Длина строки в символах должна быть от 8 до 128. |
permissions[] | Permission Набор разрешений, предоставляемых пользователю для доступа к определенным базам данных. |
conn_limit | google.protobuf.Int64Value Максимальное количество подключений к базе данных, доступное пользователю. При использовании сессионного пулинга эта настройка ограничивает количество подключений к каждому отдельному хосту в кластере PostgreSQL. В этом случае значение настройки должно быть больше общего числа подключений, которые могут быть открыты сервисами бэкенда для доступа к кластеру PostgreSQL. Значение этой настройки не должно превышать значения настройки Cluster.config.postgresql_config_12.effective_config.max_connections. При использовании транзакционного пулинга эта настройка ограничивает количество активных транзакций пользователя, поэтому в этом режиме пользователь может открывать тысячи подключений, но одновременно будет установлено только N подключений, где N — значение настройки. Минимальное значение: 10 (по умолчанию: 50 ) при использовании сессионного пулинга. Минимальная значение — 10. |
settings | UserSettings Настройки PostgreSQL для пользователя. |
login | google.protobuf.BoolValue Этот флаг определяет, может ли пользователь войти в базу данных PostgreSQL. Значение по умолчанию: true (вход разрешен). |
grants[] | string Роли и права, предоставленные пользователю ( GRANT <роль> ТО <пользователь> ). Дополнительные сведения см. в документации. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [a-zA-Z0-9_]* . |
Permission
Поле | Описание |
---|---|
database_name | string Имя базы данных, к которой предоставляет доступ разрешение. |
UserSettings
Поле | Описание |
---|---|
default_transaction_isolation | enum TransactionIsolation Для каждой транзакции в SQL устанавливается уровень изоляции. Эта настройка определяет уровень изоляции, который будет устанавливаться по умолчанию для новых транзакций SQL. См. подробное описание в документации PostgreSQL.
|
lock_timeout | google.protobuf.Int64Value Максимальная длительность ожидания (в миллисекундах) любым оператором получения блокировки таблицы, индекса, строки или другого объекта базы данных. Если ожидание не закончилось за указанное время, оператор прерывается. Значение по умолчанию: 0 (контроль длительности отключен, ожидать получения блокировки можно сколь угодно долго). |
log_min_duration_statement | google.protobuf.Int64Value Эта настройка управляет логированием длительности выполнения команд SQL. В лог записывается продолжительность выполнения всех команд, время обработки которых равно или превышает указанное в значении настройки количество миллисекунд. Например, при значении настройки 500 в лог не попадет выражение, выполнявшееся 300 миллисекунд, не будет регистрироваться, а выражение, выполнявшееся 2000 миллисекунд — попадет. Значение 0 заставляет PostgreSQL записывать продолжительность работы всех команд. Значение -1 (по умолчанию) отключает запись продолжительности выполнения команд. См. подробное описание в документации PostgreSQL. |
synchronous_commit | enum SynchronousCommit Эта настройка определяет, будет ли СУБД выполнять операцию подтверждения транзакции синхронно. Синхронность операции означает, что кластер будет ждать выполнения синхронных операций прежде чем подтвердить транзакцию клиенту. Эти операции гарантируют различные уровни сохранности и видимости данных в кластере. См. подробное описание в документации PostgreSQL.
|
temp_file_limit | google.protobuf.Int64Value Максимальный объем дискового пространства (в килобайтах), который один процесс сможет использовать для временных файлов. Транзакция, которая попытается превысить этот предел, будет отменена. Большие запросы из-за их размера выполняются PostgreSQL не в оперативной памяти, а на диске. Слишком большие запросы могут нагрузить диск и помешать выполнению других запросов. Эта настройка предотвращает выполнение запросов, которые могут сильно повлиять на производительность, ограничивая размер временных файлов. |
log_statement | enum LogStatement Эта настройка определяет, какие команды SQL должны записываться в лог (на уровне пользователя). См. подробное описание в документации PostgreSQL.
|
HostSpec
Поле | Описание |
---|---|
zone_id | string Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List. Максимальная длина строки в символах — 50. |
subnet_id | string Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети задан в поле Cluster.network_id. Максимальная длина строки в символах — 50. |
assign_public_ip | bool
|
replication_source | string Host.name of the host to be used as the replication source (for cascading replication). |
priority | google.protobuf.Int64Value Приоритет хоста как реплики. Большее значение соответствует более высокому приоритету. Хост с наивысшим приоритетом является синхронной репликой. Все остальные асинхронны. Синхронная реплика при необходимости заменяет мастер. Когда реплика становится мастером, ее приоритет игнорируется. |
config_spec | ConfigHostSpec Конфигурация сервера PostgreSQL для хоста. |
ConfigHostSpec
Поле | Описание |
---|---|
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 или postgresql_config_12_1c |
postgresql_config_9_6 | PostgresqlHostConfig9_6 Конфигурация для хоста, на котором развернут сервером PostgreSQL 9.6. |
postgresql_config_10_1c | PostgresqlHostConfig10_1C Конфигурация для хоста, на котором развернут сервер PostgreSQL 10 1С. |
postgresql_config_10 | PostgresqlHostConfig10 Конфигурация для хоста, на котором развернут сервер PostgreSQL 10. |
postgresql_config_11 | PostgresqlHostConfig11 Конфигурация для хоста, на котором развернут сервер PostgreSQL 11. |
postgresql_config_11_1c | config.PostgresqlHostConfig11_1C Конфигурация для хоста, на котором развернут сервер PostgreSQL 11 1C. |
postgresql_config_12 | PostgresqlHostConfig12 Конфигурация для хоста, на котором развернут сервер PostgreSQL 12. |
postgresql_config_12_1c | config.PostgresqlHostConfig12_1C Конфигурация для хоста, на котором развернут сервер PostgreSQL 12 1C. |
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 Идентификатор создаваемого кластера PostgreSQL. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера PostgreSQL. Этот идентификатор генерирует MDB при создании. |
folder_id | string Идентификатор каталога, которому принадлежит кластер PostgreSQL. |
created_at | google.protobuf.Timestamp Время создания в формате RFC3339 . |
name | string Имя кластера PostgreSQL. Имя уникально в рамках каталога. Длина 1-63 символов. |
description | string Описание кластера PostgreSQL. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера PostgreSQL в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания для кластера PostgreSQL.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру PostgreSQL. |
config | ClusterConfig Конфигурация кластера PostgreSQL. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Агрегированная работоспособность кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для данного кластера PostgreSQL. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения PostgreSQL. |
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 или postgresql_config_12_1c Конфигурация для серверов PostgreSQL в кластере. |
postgresql_config_9_6 | PostgresqlConfigSet9_6 Конфигурация сервера PostgreSQL 9.6. |
postgresql_config_10_1c | PostgresqlConfigSet10_1C Конфигурация сервера PostgreSQL 10 1С. |
postgresql_config_10 | PostgresqlConfigSet10 Конфигурация сервера PostgreSQL 10. |
postgresql_config_11 | PostgresqlConfigSet11 Конфигурация сервера PostgreSQL 11. |
postgresql_config_11_1c | config.PostgresqlConfigSet11_1C Конфигурация сервера PostgreSQL 11 1C. |
postgresql_config_12 | PostgresqlConfigSet12 Конфигурация сервера PostgreSQL 12. |
postgresql_config_12_1c | config.PostgresqlConfigSet12_1C Конфигурация сервера PostgreSQL 12 1C. |
pooler_config | ConnectionPoolerConfig Конфигурация менеджера соединений. |
resources | Resources Ресурсы, выделенные хостам PostgreSQL. |
autofailover | google.protobuf.BoolValue Параметр конфигурации, который включает / отключает автоматическое переключение мастера в кластере. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
ConnectionPoolerConfig
Поле | Описание |
---|---|
pooling_mode | enum PoolingMode Режим, в котором работает менеджер подключений. См. описание всех режимов в документации PgBouncer.
|
pool_discard | google.protobuf.BoolValue Установка параметра server_reset_query_always в PgBouncer. |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту, в байтах. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
Update
Изменяет указанный кластер PostgreSQL.
rpc Update (UpdateClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateClusterMetadata
Operation.response:Cluster
UpdateClusterRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор изменяемого ресурса Cluster для PostgreSQL, который нужно изменить. Чтобы получить идентификатор PostgreSQL кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
update_mask | google.protobuf.FieldMask Маска, которая указывает, какие поля ресурса Cluster для PostgreSQL должны быть изменены. |
description | string Новое описание кластера PostgreSQL. Максимальная длина строки в символах — 256. |
labels | map<string,string> Пользовательские метки для кластера PostgreSQL в виде пар key:value . Не больше 64 меток на ресурс. Например, "project": "mvp" или "source": "dictionary". Новый набор меток полностью заменит старый. Чтобы добавить метку, запросите текущий набор меток с помощью метода ClusterService.Get, затем отправьте запрос ClusterService.Update, добавив новую метку в этот набор. Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Максимальная длина строки в символах для каждого ключа — 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
config_spec | ConfigSpec Новая конфигурация и ресурсы для хостов кластера. |
name | string Новое имя кластера. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]* . |
ConfigSpec
Поле | Описание |
---|---|
version | string Версия PostgreSQL, используемая в кластере. Возможные значения 9.6 , 10 , 10_1c , 11 , 12 . |
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 или postgresql_config_12_1c Конфигурация кластера PostgreSQL. |
postgresql_config_9_6 | PostgresqlConfig9_6 Конфигурация для кластера PostgreSQL 9.6. |
postgresql_config_10_1c | PostgresqlConfig10_1C Конфигурация для кластера PostgreSQL 10. |
postgresql_config_10 | PostgresqlConfig10 Конфигурация для кластера PostgreSQL 10. |
postgresql_config_11 | PostgresqlConfig11 Конфигурация для кластера PostgreSQL 11. |
postgresql_config_11_1c | config.PostgresqlConfig11_1C Конфигурация для кластера PostgreSQL 11 1C. |
postgresql_config_12 | PostgresqlConfig12 Конфигурация для кластера PostgreSQL 12. |
postgresql_config_12_1c | config.PostgresqlConfig12_1C Конфигурация для кластера PostgreSQL 12 1C. |
pooler_config | ConnectionPoolerConfig Конфигурация менеджера соединений. |
resources | Resources Ресурсы, выделенные хостам PostgreSQL. |
autofailover | google.protobuf.BoolValue Параметр конфигурации, который включает / отключает автоматическое переключение мастера в кластере. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
ConnectionPoolerConfig
Поле | Описание |
---|---|
pooling_mode | enum PoolingMode Режим, в котором работает менеджер подключений. См. описание всех режимов в документации PgBouncer.
|
pool_discard | google.protobuf.BoolValue Установка параметра server_reset_query_always в PgBouncer. |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту, в байтах. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
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 для PostgreSQL. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера PostgreSQL. Этот идентификатор генерирует MDB при создании. |
folder_id | string Идентификатор каталога, которому принадлежит кластер PostgreSQL. |
created_at | google.protobuf.Timestamp Время создания в формате RFC3339 . |
name | string Имя кластера PostgreSQL. Имя уникально в рамках каталога. Длина 1-63 символов. |
description | string Описание кластера PostgreSQL. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера PostgreSQL в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания для кластера PostgreSQL.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру PostgreSQL. |
config | ClusterConfig Конфигурация кластера PostgreSQL. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Агрегированная работоспособность кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для данного кластера PostgreSQL. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения PostgreSQL. |
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 или postgresql_config_12_1c Конфигурация для серверов PostgreSQL в кластере. |
postgresql_config_9_6 | PostgresqlConfigSet9_6 Конфигурация сервера PostgreSQL 9.6. |
postgresql_config_10_1c | PostgresqlConfigSet10_1C Конфигурация сервера PostgreSQL 10 1С. |
postgresql_config_10 | PostgresqlConfigSet10 Конфигурация сервера PostgreSQL 10. |
postgresql_config_11 | PostgresqlConfigSet11 Конфигурация сервера PostgreSQL 11. |
postgresql_config_11_1c | config.PostgresqlConfigSet11_1C Конфигурация сервера PostgreSQL 11 1C. |
postgresql_config_12 | PostgresqlConfigSet12 Конфигурация сервера PostgreSQL 12. |
postgresql_config_12_1c | config.PostgresqlConfigSet12_1C Конфигурация сервера PostgreSQL 12 1C. |
pooler_config | ConnectionPoolerConfig Конфигурация менеджера соединений. |
resources | Resources Ресурсы, выделенные хостам PostgreSQL. |
autofailover | google.protobuf.BoolValue Параметр конфигурации, который включает / отключает автоматическое переключение мастера в кластере. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
ConnectionPoolerConfig
Поле | Описание |
---|---|
pooling_mode | enum PoolingMode Режим, в котором работает менеджер подключений. См. описание всех режимов в документации PgBouncer.
|
pool_discard | google.protobuf.BoolValue Установка параметра server_reset_query_always в PgBouncer. |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту, в байтах. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
Delete
Удаляет указанный кластер PostgreSQL.
rpc Delete (DeleteClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:DeleteClusterMetadata
Operation.response:google.protobuf.Empty
DeleteClusterRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера PostgreSQL, который следует удалить. Чтобы получить идентификатор PostgreSQL кластера, используйте запрос 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 Идентификатор удаляемого кластера PostgreSQL. |
Start
Запускает указанный кластер PostgreSQL.
rpc Start (StartClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:StartClusterMetadata
Operation.response:Cluster
StartClusterRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера PostgreSQL, который следует запустить. Максимальная длина строки в символах — 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 Идентификатор кластера PostgreSQL. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера PostgreSQL. Этот идентификатор генерирует MDB при создании. |
folder_id | string Идентификатор каталога, которому принадлежит кластер PostgreSQL. |
created_at | google.protobuf.Timestamp Время создания в формате RFC3339 . |
name | string Имя кластера PostgreSQL. Имя уникально в рамках каталога. Длина 1-63 символов. |
description | string Описание кластера PostgreSQL. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера PostgreSQL в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания для кластера PostgreSQL.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру PostgreSQL. |
config | ClusterConfig Конфигурация кластера PostgreSQL. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Агрегированная работоспособность кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для данного кластера PostgreSQL. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения PostgreSQL. |
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 или postgresql_config_12_1c Конфигурация для серверов PostgreSQL в кластере. |
postgresql_config_9_6 | PostgresqlConfigSet9_6 Конфигурация сервера PostgreSQL 9.6. |
postgresql_config_10_1c | PostgresqlConfigSet10_1C Конфигурация сервера PostgreSQL 10 1С. |
postgresql_config_10 | PostgresqlConfigSet10 Конфигурация сервера PostgreSQL 10. |
postgresql_config_11 | PostgresqlConfigSet11 Конфигурация сервера PostgreSQL 11. |
postgresql_config_11_1c | config.PostgresqlConfigSet11_1C Конфигурация сервера PostgreSQL 11 1C. |
postgresql_config_12 | PostgresqlConfigSet12 Конфигурация сервера PostgreSQL 12. |
postgresql_config_12_1c | config.PostgresqlConfigSet12_1C Конфигурация сервера PostgreSQL 12 1C. |
pooler_config | ConnectionPoolerConfig Конфигурация менеджера соединений. |
resources | Resources Ресурсы, выделенные хостам PostgreSQL. |
autofailover | google.protobuf.BoolValue Параметр конфигурации, который включает / отключает автоматическое переключение мастера в кластере. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
ConnectionPoolerConfig
Поле | Описание |
---|---|
pooling_mode | enum PoolingMode Режим, в котором работает менеджер подключений. См. описание всех режимов в документации PgBouncer.
|
pool_discard | google.protobuf.BoolValue Установка параметра server_reset_query_always в PgBouncer. |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту, в байтах. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
Stop
Останавливает указанный кластер PostgreSQL.
rpc Stop (StopClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:StopClusterMetadata
Operation.response:Cluster
StopClusterRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера PostgreSQL, который следует остановить. Максимальная длина строки в символах — 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 Идентификатор кластера PostgreSQL. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера PostgreSQL. Этот идентификатор генерирует MDB при создании. |
folder_id | string Идентификатор каталога, которому принадлежит кластер PostgreSQL. |
created_at | google.protobuf.Timestamp Время создания в формате RFC3339 . |
name | string Имя кластера PostgreSQL. Имя уникально в рамках каталога. Длина 1-63 символов. |
description | string Описание кластера PostgreSQL. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера PostgreSQL в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания для кластера PostgreSQL.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру PostgreSQL. |
config | ClusterConfig Конфигурация кластера PostgreSQL. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Агрегированная работоспособность кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для данного кластера PostgreSQL. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения PostgreSQL. |
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 или postgresql_config_12_1c Конфигурация для серверов PostgreSQL в кластере. |
postgresql_config_9_6 | PostgresqlConfigSet9_6 Конфигурация сервера PostgreSQL 9.6. |
postgresql_config_10_1c | PostgresqlConfigSet10_1C Конфигурация сервера PostgreSQL 10 1С. |
postgresql_config_10 | PostgresqlConfigSet10 Конфигурация сервера PostgreSQL 10. |
postgresql_config_11 | PostgresqlConfigSet11 Конфигурация сервера PostgreSQL 11. |
postgresql_config_11_1c | config.PostgresqlConfigSet11_1C Конфигурация сервера PostgreSQL 11 1C. |
postgresql_config_12 | PostgresqlConfigSet12 Конфигурация сервера PostgreSQL 12. |
postgresql_config_12_1c | config.PostgresqlConfigSet12_1C Конфигурация сервера PostgreSQL 12 1C. |
pooler_config | ConnectionPoolerConfig Конфигурация менеджера соединений. |
resources | Resources Ресурсы, выделенные хостам PostgreSQL. |
autofailover | google.protobuf.BoolValue Параметр конфигурации, который включает / отключает автоматическое переключение мастера в кластере. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
ConnectionPoolerConfig
Поле | Описание |
---|---|
pooling_mode | enum PoolingMode Режим, в котором работает менеджер подключений. См. описание всех режимов в документации PgBouncer.
|
pool_discard | google.protobuf.BoolValue Установка параметра server_reset_query_always в PgBouncer. |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту, в байтах. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
Move
Перемещает кластер PostgreSQL в указанный каталог.
rpc Move (MoveClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:MoveClusterMetadata
Operation.response:Cluster
MoveClusterRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера PostgreSQL, который следует переместить. Максимальная длина строки в символах — 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 Идентификатор перемещаемого кластера PostgreSQL. |
source_folder_id | string Идентификатор исходного каталога. |
destination_folder_id | string Идентификатор каталога назначения. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера PostgreSQL. Этот идентификатор генерирует MDB при создании. |
folder_id | string Идентификатор каталога, которому принадлежит кластер PostgreSQL. |
created_at | google.protobuf.Timestamp Время создания в формате RFC3339 . |
name | string Имя кластера PostgreSQL. Имя уникально в рамках каталога. Длина 1-63 символов. |
description | string Описание кластера PostgreSQL. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера PostgreSQL в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания для кластера PostgreSQL.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру PostgreSQL. |
config | ClusterConfig Конфигурация кластера PostgreSQL. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Агрегированная работоспособность кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для данного кластера PostgreSQL. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения PostgreSQL. |
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 или postgresql_config_12_1c Конфигурация для серверов PostgreSQL в кластере. |
postgresql_config_9_6 | PostgresqlConfigSet9_6 Конфигурация сервера PostgreSQL 9.6. |
postgresql_config_10_1c | PostgresqlConfigSet10_1C Конфигурация сервера PostgreSQL 10 1С. |
postgresql_config_10 | PostgresqlConfigSet10 Конфигурация сервера PostgreSQL 10. |
postgresql_config_11 | PostgresqlConfigSet11 Конфигурация сервера PostgreSQL 11. |
postgresql_config_11_1c | config.PostgresqlConfigSet11_1C Конфигурация сервера PostgreSQL 11 1C. |
postgresql_config_12 | PostgresqlConfigSet12 Конфигурация сервера PostgreSQL 12. |
postgresql_config_12_1c | config.PostgresqlConfigSet12_1C Конфигурация сервера PostgreSQL 12 1C. |
pooler_config | ConnectionPoolerConfig Конфигурация менеджера соединений. |
resources | Resources Ресурсы, выделенные хостам PostgreSQL. |
autofailover | google.protobuf.BoolValue Параметр конфигурации, который включает / отключает автоматическое переключение мастера в кластере. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
ConnectionPoolerConfig
Поле | Описание |
---|---|
pooling_mode | enum PoolingMode Режим, в котором работает менеджер подключений. См. описание всех режимов в документации PgBouncer.
|
pool_discard | google.protobuf.BoolValue Установка параметра server_reset_query_always в PgBouncer. |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту, в байтах. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
Backup
Создает резервную копию для указанного кластера PostgreSQL.
rpc Backup (BackupClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:BackupClusterMetadata
Operation.response:Cluster
BackupClusterRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера PostgreSQL, для которого следует создать резервную копию. Чтобы получить идентификатор PostgreSQL кластера, используйте запрос 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 Идентификатор кластера PostgreSQL, для которого выполняется резервное копирование. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера PostgreSQL. Этот идентификатор генерирует MDB при создании. |
folder_id | string Идентификатор каталога, которому принадлежит кластер PostgreSQL. |
created_at | google.protobuf.Timestamp Время создания в формате RFC3339 . |
name | string Имя кластера PostgreSQL. Имя уникально в рамках каталога. Длина 1-63 символов. |
description | string Описание кластера PostgreSQL. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера PostgreSQL в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания для кластера PostgreSQL.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру PostgreSQL. |
config | ClusterConfig Конфигурация кластера PostgreSQL. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Агрегированная работоспособность кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для данного кластера PostgreSQL. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения PostgreSQL. |
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 или postgresql_config_12_1c Конфигурация для серверов PostgreSQL в кластере. |
postgresql_config_9_6 | PostgresqlConfigSet9_6 Конфигурация сервера PostgreSQL 9.6. |
postgresql_config_10_1c | PostgresqlConfigSet10_1C Конфигурация сервера PostgreSQL 10 1С. |
postgresql_config_10 | PostgresqlConfigSet10 Конфигурация сервера PostgreSQL 10. |
postgresql_config_11 | PostgresqlConfigSet11 Конфигурация сервера PostgreSQL 11. |
postgresql_config_11_1c | config.PostgresqlConfigSet11_1C Конфигурация сервера PostgreSQL 11 1C. |
postgresql_config_12 | PostgresqlConfigSet12 Конфигурация сервера PostgreSQL 12. |
postgresql_config_12_1c | config.PostgresqlConfigSet12_1C Конфигурация сервера PostgreSQL 12 1C. |
pooler_config | ConnectionPoolerConfig Конфигурация менеджера соединений. |
resources | Resources Ресурсы, выделенные хостам PostgreSQL. |
autofailover | google.protobuf.BoolValue Параметр конфигурации, который включает / отключает автоматическое переключение мастера в кластере. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
ConnectionPoolerConfig
Поле | Описание |
---|---|
pooling_mode | enum PoolingMode Режим, в котором работает менеджер подключений. См. описание всех режимов в документации PgBouncer.
|
pool_discard | google.protobuf.BoolValue Установка параметра server_reset_query_always в PgBouncer. |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту, в байтах. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
Restore
Создает новый кластер PostgreSQL с использованием указанной резервной копии.
rpc Restore (RestoreClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:RestoreClusterMetadata
Operation.response:Cluster
RestoreClusterRequest
Поле | Описание |
---|---|
backup_id | string Обязательное поле. Идентификатор резервной копии, из которой следует создать кластер. Чтобы получить идентификатор резервной копии, используйте запрос ClusterService.ListBackups. |
time | google.protobuf.Timestamp Обязательное поле. Момент времени, на который должен быть восстановлен кластер PostgreSQL. |
time_inclusive | bool
|
name | string Обязательное поле. Имя нового кластера PostgreSQL. Имя должно быть уникальным в каталоге. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]* . |
description | string Описание нового кластера PostgreSQL. Максимальная длина строки в символах — 256. |
labels | map<string,string> Пользовательские метки для кластера PostgreSQL в виде пар key:value . Не больше 64 меток на ресурс. Например, "project": "mvp" или "source": "dictionary". Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Максимальная длина строки в символах для каждого ключа — 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
environment | Cluster.Environment Среда развертывания для нового кластера PostgreSQL. |
config_spec | ConfigSpec Конфигурация для создаваемого кластера PostgreSQL. |
host_specs[] | HostSpec Конфигурации для хостов PostgreSQL, которые должны быть созданы для кластера, создаваемого из резервной копии. Количество элементов должно быть больше 0. |
network_id | string Обязательное поле. Идентификатор сети, в которой нужно создать PostgreSQL кластер. Максимальная длина строки в символах — 50. |
folder_id | string Идентификатор каталога, в котором нужно создать кластер PostgreSQL. Максимальная длина строки в символах — 50. |
ConfigSpec
Поле | Описание |
---|---|
version | string Версия PostgreSQL, используемая в кластере. Возможные значения 9.6 , 10 , 10_1c , 11 , 12 . |
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 или postgresql_config_12_1c Конфигурация кластера PostgreSQL. |
postgresql_config_9_6 | PostgresqlConfig9_6 Конфигурация для кластера PostgreSQL 9.6. |
postgresql_config_10_1c | PostgresqlConfig10_1C Конфигурация для кластера PostgreSQL 10. |
postgresql_config_10 | PostgresqlConfig10 Конфигурация для кластера PostgreSQL 10. |
postgresql_config_11 | PostgresqlConfig11 Конфигурация для кластера PostgreSQL 11. |
postgresql_config_11_1c | config.PostgresqlConfig11_1C Конфигурация для кластера PostgreSQL 11 1C. |
postgresql_config_12 | PostgresqlConfig12 Конфигурация для кластера PostgreSQL 12. |
postgresql_config_12_1c | config.PostgresqlConfig12_1C Конфигурация для кластера PostgreSQL 12 1C. |
pooler_config | ConnectionPoolerConfig Конфигурация менеджера соединений. |
resources | Resources Ресурсы, выделенные хостам PostgreSQL. |
autofailover | google.protobuf.BoolValue Параметр конфигурации, который включает / отключает автоматическое переключение мастера в кластере. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
ConnectionPoolerConfig
Поле | Описание |
---|---|
pooling_mode | enum PoolingMode Режим, в котором работает менеджер подключений. См. описание всех режимов в документации PgBouncer.
|
pool_discard | google.protobuf.BoolValue Установка параметра server_reset_query_always в PgBouncer. |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту, в байтах. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
HostSpec
Поле | Описание |
---|---|
zone_id | string Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List. Максимальная длина строки в символах — 50. |
subnet_id | string Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети задан в поле Cluster.network_id. Максимальная длина строки в символах — 50. |
assign_public_ip | bool
|
replication_source | string Host.name of the host to be used as the replication source (for cascading replication). |
priority | google.protobuf.Int64Value Приоритет хоста как реплики. Большее значение соответствует более высокому приоритету. Хост с наивысшим приоритетом является синхронной репликой. Все остальные асинхронны. Синхронная реплика при необходимости заменяет мастер. Когда реплика становится мастером, ее приоритет игнорируется. |
config_spec | ConfigHostSpec Конфигурация сервера PostgreSQL для хоста. |
ConfigHostSpec
Поле | Описание |
---|---|
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 или postgresql_config_12_1c |
postgresql_config_9_6 | PostgresqlHostConfig9_6 Конфигурация для хоста, на котором развернут сервером PostgreSQL 9.6. |
postgresql_config_10_1c | PostgresqlHostConfig10_1C Конфигурация для хоста, на котором развернут сервер PostgreSQL 10 1С. |
postgresql_config_10 | PostgresqlHostConfig10 Конфигурация для хоста, на котором развернут сервер PostgreSQL 10. |
postgresql_config_11 | PostgresqlHostConfig11 Конфигурация для хоста, на котором развернут сервер PostgreSQL 11. |
postgresql_config_11_1c | config.PostgresqlHostConfig11_1C Конфигурация для хоста, на котором развернут сервер PostgreSQL 11 1C. |
postgresql_config_12 | PostgresqlHostConfig12 Конфигурация для хоста, на котором развернут сервер PostgreSQL 12. |
postgresql_config_12_1c | config.PostgresqlHostConfig12_1C Конфигурация для хоста, на котором развернут сервер PostgreSQL 12 1C. |
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 Идентификатор нового кластера PostgreSQL, создаваемого из резервной копии. |
backup_id | string Идентификатор резервной копии, используемой для создания кластера. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера PostgreSQL. Этот идентификатор генерирует MDB при создании. |
folder_id | string Идентификатор каталога, которому принадлежит кластер PostgreSQL. |
created_at | google.protobuf.Timestamp Время создания в формате RFC3339 . |
name | string Имя кластера PostgreSQL. Имя уникально в рамках каталога. Длина 1-63 символов. |
description | string Описание кластера PostgreSQL. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера PostgreSQL в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания для кластера PostgreSQL.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру PostgreSQL. |
config | ClusterConfig Конфигурация кластера PostgreSQL. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Агрегированная работоспособность кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для данного кластера PostgreSQL. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения PostgreSQL. |
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 или postgresql_config_12_1c Конфигурация для серверов PostgreSQL в кластере. |
postgresql_config_9_6 | PostgresqlConfigSet9_6 Конфигурация сервера PostgreSQL 9.6. |
postgresql_config_10_1c | PostgresqlConfigSet10_1C Конфигурация сервера PostgreSQL 10 1С. |
postgresql_config_10 | PostgresqlConfigSet10 Конфигурация сервера PostgreSQL 10. |
postgresql_config_11 | PostgresqlConfigSet11 Конфигурация сервера PostgreSQL 11. |
postgresql_config_11_1c | config.PostgresqlConfigSet11_1C Конфигурация сервера PostgreSQL 11 1C. |
postgresql_config_12 | PostgresqlConfigSet12 Конфигурация сервера PostgreSQL 12. |
postgresql_config_12_1c | config.PostgresqlConfigSet12_1C Конфигурация сервера PostgreSQL 12 1C. |
pooler_config | ConnectionPoolerConfig Конфигурация менеджера соединений. |
resources | Resources Ресурсы, выделенные хостам PostgreSQL. |
autofailover | google.protobuf.BoolValue Параметр конфигурации, который включает / отключает автоматическое переключение мастера в кластере. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
ConnectionPoolerConfig
Поле | Описание |
---|---|
pooling_mode | enum PoolingMode Режим, в котором работает менеджер подключений. См. описание всех режимов в документации PgBouncer.
|
pool_discard | google.protobuf.BoolValue Установка параметра server_reset_query_always в PgBouncer. |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту, в байтах. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
StartFailover
Запускает ручное переключение мастера для указанного кластера PostgreSQL.
rpc StartFailover (StartClusterFailoverRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:StartClusterFailoverMetadata
Operation.response:Cluster
StartClusterFailoverRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера PostgreSQL. Максимальная длина строки в символах — 50. |
host_name | string Новый хост-мастер. Если хост не указан, кластер переключается на реплику с самыми свежими данными. Максимальная длина строки в символах — 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<StartClusterFailoverMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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> в случае успешного выполнения операции. |
StartClusterFailoverMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера PostgreSQL, для которого переключается мастер. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера PostgreSQL. Этот идентификатор генерирует MDB при создании. |
folder_id | string Идентификатор каталога, которому принадлежит кластер PostgreSQL. |
created_at | google.protobuf.Timestamp Время создания в формате RFC3339 . |
name | string Имя кластера PostgreSQL. Имя уникально в рамках каталога. Длина 1-63 символов. |
description | string Описание кластера PostgreSQL. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера PostgreSQL в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания для кластера PostgreSQL.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру PostgreSQL. |
config | ClusterConfig Конфигурация кластера PostgreSQL. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Агрегированная работоспособность кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для данного кластера PostgreSQL. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения PostgreSQL. |
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 или postgresql_config_12_1c Конфигурация для серверов PostgreSQL в кластере. |
postgresql_config_9_6 | PostgresqlConfigSet9_6 Конфигурация сервера PostgreSQL 9.6. |
postgresql_config_10_1c | PostgresqlConfigSet10_1C Конфигурация сервера PostgreSQL 10 1С. |
postgresql_config_10 | PostgresqlConfigSet10 Конфигурация сервера PostgreSQL 10. |
postgresql_config_11 | PostgresqlConfigSet11 Конфигурация сервера PostgreSQL 11. |
postgresql_config_11_1c | config.PostgresqlConfigSet11_1C Конфигурация сервера PostgreSQL 11 1C. |
postgresql_config_12 | PostgresqlConfigSet12 Конфигурация сервера PostgreSQL 12. |
postgresql_config_12_1c | config.PostgresqlConfigSet12_1C Конфигурация сервера PostgreSQL 12 1C. |
pooler_config | ConnectionPoolerConfig Конфигурация менеджера соединений. |
resources | Resources Ресурсы, выделенные хостам PostgreSQL. |
autofailover | google.protobuf.BoolValue Параметр конфигурации, который включает / отключает автоматическое переключение мастера в кластере. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
ConnectionPoolerConfig
Поле | Описание |
---|---|
pooling_mode | enum PoolingMode Режим, в котором работает менеджер подключений. См. описание всех режимов в документации PgBouncer.
|
pool_discard | google.protobuf.BoolValue Установка параметра server_reset_query_always в PgBouncer. |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту, в байтах. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
ListLogs
Получает логи для указанного кластера PostgreSQL.
rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)
ListClusterLogsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера PostgreSQL, для которого следует запросить логи. Чтобы получить идентификатор PostgreSQL кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
column_filter[] | string Столбцы из таблицы логов для запроса. Если столбцы не указаны, записи логов возвращаются целиком. |
service_type | enum ServiceType Тип сервиса, для которого следует запросить логи.
|
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. |
always_next_page_token | bool Всегда возвращает next_page_token , даже если текущая страница пуста. |
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 для PostgreSQL, для которого запрашивается список операций. Максимальная длина строки в символах — 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 для указанного кластера PostgreSQL. |
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
Получает список доступных резервных копий для указанного кластера PostgreSQL.
rpc ListBackups (ListClusterBackupsRequest) returns (ListClusterBackupsResponse)
ListClusterBackupsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера PostgreSQL. Чтобы получить идентификатор PostgreSQL кластера, используйте запрос 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 для PostgreSQL. |
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 Идентификатор кластера PostgreSQL, для которого была создана резервная копия. |
started_at | google.protobuf.Timestamp Время запуска операции резервного копирования. |
ListHosts
Получает список хостов для указанного кластера.
rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)
ListClusterHostsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера PostgreSQL. Чтобы получить идентификатор PostgreSQL кластера, используйте запрос 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 Имя хоста PostgreSQL. Имя хоста назначается MDB во время создания и не может быть изменено. Длина 1-63 символов. Имя уникально для всех существующих хостов MDB в Яндекс.Облаке, так как оно определяет полное доменное имя (FQDN) хоста. |
cluster_id | string Идентификатор хоста PostgreSQL. Этот идентификатор генерирует MDB при создании. |
zone_id | string Идентификатор зоны доступности, в которой находится хост PostgreSQL. |
resources | Resources Ресурсы, выделенные для хоста PostgreSQL. |
role | enum Role Роль хоста в кластере.
|
health | enum Health Код работоспособности хоста.
|
services[] | Service Сервисы, предоставляемые хостом. |
subnet_id | string Идентификатор подсети, к которой принадлежит хост. |
replication_source | string Имя хоста, который будет использоваться в качестве источника репликации (для каскадной репликации). |
priority | google.protobuf.Int64Value Приоритет хоста как реплики. Более высокое значение соответствует более высокому приоритету. Хост с наивысшим приоритетом является синхронной репликой. Все остальные асинхронны. Синхронная реплика при необходимости заменяет мастер. Когда реплика становится мастером, ее приоритет игнорируется. |
config | HostConfig Конфигурация сервера PostgreSQL для хоста. |
assign_public_ip | bool Флаг, показывающий статус публичного IP-адреса для этого хоста. |
replica_type | enum ReplicaType |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту, в байтах. |
disk_type_id | string
|
Service
Поле | Описание |
---|---|
type | enum Type Тип сервиса, предоставляемого хостом.
|
health | enum Health Код состояния доступности сервера.
|
HostConfig
Поле | Описание |
---|---|
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 или postgresql_config_12_1c Конфигурация сервера PostgreSQL для хоста. |
postgresql_config_9_6 | PostgresqlHostConfig9_6 Конфигурация для хоста, на котором развернут сервером PostgreSQL 9.6. |
postgresql_config_10_1c | PostgresqlHostConfig10_1C Конфигурация для хоста, на котором развернут сервер PostgreSQL 10 1С. |
postgresql_config_10 | PostgresqlHostConfig10 Конфигурация для хоста, на котором развернут сервер PostgreSQL 10. |
postgresql_config_11 | PostgresqlHostConfig11 Конфигурация для хоста, на котором развернут сервер PostgreSQL 11. |
postgresql_config_11_1c | config.PostgresqlHostConfig11_1C Конфигурация для хоста, на котором развернут сервер PostgreSQL 11 1C. |
postgresql_config_12 | PostgresqlHostConfig12 Конфигурация для хоста, на котором развернут сервер PostgreSQL 12. |
postgresql_config_12_1c | config.PostgresqlHostConfig12_1C Конфигурация для хоста, на котором развернут сервер PostgreSQL 12 1C. |
AddHosts
Создает новые хосты для кластера.
rpc AddHosts (AddClusterHostsRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:AddClusterHostsMetadata
Operation.response:google.protobuf.Empty
AddClusterHostsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера PostgreSQL, для которого следует добавить хосты. Чтобы получить идентификатор PostgreSQL кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
host_specs[] | HostSpec Конфигурации для хостов PostgreSQL, которые должны быть добавлены в кластер. Количество элементов должно быть больше 0. |
HostSpec
Поле | Описание |
---|---|
zone_id | string Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List. Максимальная длина строки в символах — 50. |
subnet_id | string Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети задан в поле Cluster.network_id. Максимальная длина строки в символах — 50. |
assign_public_ip | bool
|
replication_source | string Host.name of the host to be used as the replication source (for cascading replication). |
priority | google.protobuf.Int64Value Приоритет хоста как реплики. Большее значение соответствует более высокому приоритету. Хост с наивысшим приоритетом является синхронной репликой. Все остальные асинхронны. Синхронная реплика при необходимости заменяет мастер. Когда реплика становится мастером, ее приоритет игнорируется. |
config_spec | ConfigHostSpec Конфигурация сервера PostgreSQL для хоста. |
ConfigHostSpec
Поле | Описание |
---|---|
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 или postgresql_config_12_1c |
postgresql_config_9_6 | PostgresqlHostConfig9_6 Конфигурация для хоста, на котором развернут сервером PostgreSQL 9.6. |
postgresql_config_10_1c | PostgresqlHostConfig10_1C Конфигурация для хоста, на котором развернут сервер PostgreSQL 10 1С. |
postgresql_config_10 | PostgresqlHostConfig10 Конфигурация для хоста, на котором развернут сервер PostgreSQL 10. |
postgresql_config_11 | PostgresqlHostConfig11 Конфигурация для хоста, на котором развернут сервер PostgreSQL 11. |
postgresql_config_11_1c | config.PostgresqlHostConfig11_1C Конфигурация для хоста, на котором развернут сервер PostgreSQL 11 1C. |
postgresql_config_12 | PostgresqlHostConfig12 Конфигурация для хоста, на котором развернут сервер PostgreSQL 12. |
postgresql_config_12_1c | config.PostgresqlHostConfig12_1C Конфигурация для хоста, на котором развернут сервер PostgreSQL 12 1C. |
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 Идентификатор кластера PostgreSQL, в который добавляются хосты. |
host_names[] | string Имена хостов, добавляемых в кластер. |
DeleteHosts
Удаляет указанные хосты кластера.
rpc DeleteHosts (DeleteClusterHostsRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:DeleteClusterHostsMetadata
Operation.response:google.protobuf.Empty
DeleteClusterHostsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера PostgreSQL из которого следует удалить хосты. Чтобы получить идентификатор PostgreSQL кластера, используйте запрос 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 Идентификатор кластера PostgreSQL из которого следует удалить хосты. |
host_names[] | string Имена удаляемых хостов. |
UpdateHosts
Обновляет указанные хосты.
rpc UpdateHosts (UpdateClusterHostsRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateClusterHostsMetadata
Operation.response:google.protobuf.Empty
UpdateClusterHostsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера PostgreSQL, в котором следует обновить хосты. Чтобы получить идентификатор PostgreSQL кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
update_host_specs[] | UpdateHostSpec Новые конфигурации, которые следует применить к хостам. Количество элементов должно быть больше 0. |
UpdateHostSpec
Поле | Описание |
---|---|
host_name | string Обязательное поле. Имя хоста, который следует обновить. Чтобы получить имя хоста PostgreSQL, используйте запрос ClusterService.ListHosts. |
replication_source | string Host.name хоста, который будет использоваться в качестве источника репликации (для каскадной репликации). Чтобы получить имя хоста PostgreSQL, используйте запрос ClusterService.ListHosts. |
priority | google.protobuf.Int64Value Хост с наивысшим приоритетом является синхронной репликой. Все остальные асинхронны. Синхронная реплика при необходимости заменяет мастер. Когда реплика становится мастером, ее приоритет игнорируется. |
config_spec | ConfigHostSpec Конфигурация сервера PostgreSQL для хоста. |
ConfigHostSpec
Поле | Описание |
---|---|
postgresql_config | oneof: postgresql_config_9_6 , postgresql_config_10_1c , postgresql_config_10 , postgresql_config_11 , postgresql_config_11_1c , postgresql_config_12 или postgresql_config_12_1c |
postgresql_config_9_6 | PostgresqlHostConfig9_6 Конфигурация для хоста, на котором развернут сервером PostgreSQL 9.6. |
postgresql_config_10_1c | PostgresqlHostConfig10_1C Конфигурация для хоста, на котором развернут сервер PostgreSQL 10 1С. |
postgresql_config_10 | PostgresqlHostConfig10 Конфигурация для хоста, на котором развернут сервер PostgreSQL 10. |
postgresql_config_11 | PostgresqlHostConfig11 Конфигурация для хоста, на котором развернут сервер PostgreSQL 11. |
postgresql_config_11_1c | config.PostgresqlHostConfig11_1C Конфигурация для хоста, на котором развернут сервер PostgreSQL 11 1C. |
postgresql_config_12 | PostgresqlHostConfig12 Конфигурация для хоста, на котором развернут сервер PostgreSQL 12. |
postgresql_config_12_1c | config.PostgresqlHostConfig12_1C Конфигурация для хоста, на котором развернут сервер PostgreSQL 12 1C. |
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<UpdateClusterHostsMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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> в случае успешного выполнения операции. |
UpdateClusterHostsMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера PostgreSQL, в котором следует обновить хосты. |
host_names[] | string Имена обновляемых хостов. |