ClusterService
Набор методов для управления кластерами MySQL.
Вызов | Описание |
---|---|
Get | Возвращает указанный кластер MySQL. |
List | Возвращает список кластеров MySQL, принадлежащих указанному каталогу. |
Create | Создает кластер MySQL в указанном каталоге. |
Update | Изменяет указанный кластер MySQL. |
Delete | Удаляет указанный кластер MySQL. |
Start | Запускает указанный кластер MySQL. |
Stop | Останавливает указанный кластер MySQL. |
Move | Перемещает кластер MySQL в указанный каталог. |
Backup | Создает резервную копию для указанного кластера MySQL. |
Restore | Создает новый кластер MySQL с использованием указанной резервной копии. |
StartFailover | Запускает ручное переключение мастера для указанного кластера MySQL. |
ListLogs | Получает логи для указанного кластера MySQL. |
ListOperations | Возвращает список операций для указанного кластера MySQL. |
ListBackups | Получает список доступных резервных копий для указанного кластера MySQL. |
ListHosts | Получает список хостов для указанного кластера MySQL. |
AddHosts | Создает новые хосты для кластера. |
DeleteHosts | Удаляет указанные хосты кластера. |
Вызовы ClusterService
Get
Возвращает указанный кластер MySQL.
Чтобы получить список доступных кластеров MySQL, выполните запрос List.
rpc Get (GetClusterRequest) returns (Cluster)
GetClusterRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор возвращаемого кластера MySQL. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера MySQL. Этот идентификатор Managed Service for MySQL генерирует при создании. |
folder_id | string Идентификатор каталога, которому принадлежит кластер MySQL. |
created_at | google.protobuf.Timestamp |
name | string Имя кластера MySQL. Имя должно быть уникальным в каталоге, соответствовать RFC 1035 и иметь длину 1-63 символа. |
description | string Описание кластера MySQL. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера MySQL в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания кластера MySQL.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру MySQL. |
config | ClusterConfig Конфигурация кластера MySQL. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Агрегированная работоспособность кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для кластера MySQL. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения MySQL. |
mysql_config | oneof: mysql_config_5_7 или mysql_config_8_0 Конфигурация для серверов MySQL в кластере. |
mysql_config_5_7 | config.MysqlConfigSet5_7 Конфигурация сервера MySQL 5.7. |
mysql_config_8_0 | config.MysqlConfigSet8_0 Конфигурация сервера MySQL 8.0. |
resources | Resources Ресурсы, выделенные хостам MySQL. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
List
Возвращает список кластеров MySQL, принадлежащих указанному каталогу.
rpc List (ListClustersRequest) returns (ListClustersResponse)
ListClustersRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога, для которого нужно получить список кластеров MySQL. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListClustersResponse.next_page_token, которое можно использовать для получения следующей страницы. Допустимые значения — от 0 до 1000 включительно. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListClustersResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | string
|
ListClustersResponse
Поле | Описание |
---|---|
clusters[] | Cluster Список кластеров MySQL. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClustersRequest.page_size, используйте next_page_token в качестве значения параметра ListClustersRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера MySQL. Этот идентификатор Managed Service for MySQL генерирует при создании. |
folder_id | string Идентификатор каталога, которому принадлежит кластер MySQL. |
created_at | google.protobuf.Timestamp |
name | string Имя кластера MySQL. Имя должно быть уникальным в каталоге, соответствовать RFC 1035 и иметь длину 1-63 символа. |
description | string Описание кластера MySQL. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера MySQL в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания кластера MySQL.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру MySQL. |
config | ClusterConfig Конфигурация кластера MySQL. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Агрегированная работоспособность кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для кластера MySQL. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения MySQL. |
mysql_config | oneof: mysql_config_5_7 или mysql_config_8_0 Конфигурация для серверов MySQL в кластере. |
mysql_config_5_7 | config.MysqlConfigSet5_7 Конфигурация сервера MySQL 5.7. |
mysql_config_8_0 | config.MysqlConfigSet8_0 Конфигурация сервера MySQL 8.0. |
resources | Resources Ресурсы, выделенные хостам MySQL. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
Create
Создает кластер MySQL в указанном каталоге.
rpc Create (CreateClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:CreateClusterMetadata
Operation.response:Cluster
CreateClusterRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога, в котором нужно создать кластер MySQL. Максимальная длина строки в символах — 50. |
name | string Обязательное поле. Имя кластера MySQL. Имя должно быть уникальным в каталоге. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]* . |
description | string Описание кластера MySQL. Максимальная длина строки в символах — 256. |
labels | map<string,string> Пользовательские метки для кластера MySQL в виде пар key:value . Максимум 64 на ресурс. Например, "project": "mvp" или "source": "dictionary". Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
environment | Cluster.Environment Среда развертывания кластера MySQL. |
config_spec | ConfigSpec Конфигурация и ресурсы для хостов, которые должны быть созданы для кластера MySQL. |
database_specs[] | DatabaseSpec Описания баз данных, которые нужно создать в кластере MySQL. |
user_specs[] | UserSpec Описания пользователей базы данных, которых нужно создать в кластере MySQL. |
host_specs[] | HostSpec Конфигурации для отдельных хостов, которые должны быть созданы для кластера MySQL. |
network_id | string Идентификатор сети, в которой нужно создать кластер. Максимальная длина строки в символах — 50. |
ConfigSpec
Поле | Описание |
---|---|
version | string
|
mysql_config | oneof: mysql_config_5_7 или mysql_config_8_0 Конфигурация кластера MySQL. |
mysql_config_5_7 | config.MysqlConfig5_7 Конфигурация для кластера MySQL 5.7. |
mysql_config_8_0 | config.MysqlConfig8_0 Конфигурация для кластера MySQL 8.0. |
resources | Resources Ресурсы, выделенные хостам MySQL. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД. |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
DatabaseSpec
Поле | Описание |
---|---|
name | string Обязательное поле. Имя базы данных MySQL. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]* . |
UserSpec
Поле | Описание |
---|---|
name | string Обязательное поле. Имя пользователя MySQL. Максимальная длина строки в символах — 32. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]* . |
password | string Обязательное поле. Пароль пользователя MySQL. Длина строки в символах должна быть от 8 до 128. |
permissions[] | Permission Набор разрешений, которые следует предоставить пользователю. |
global_permissions[] | enum GlobalPermission Набор глобальных разрешений, которые следует предоставить пользователю.
|
connection_limits | ConnectionLimits Набор ограничений на коннекты пользователя. |
authentication_plugin | enum AuthPlugin Аутентификационный плагин пользователя.
|
Permission
Поле | Описание |
---|---|
database_name | string Имя базы данных, к которой предоставляет доступ разрешение. |
roles[] | enum Privilege Роли, предоставленные пользователю в базе данных. Минимальное количество элементов — 1.
|
ConnectionLimits
Поле | Описание |
---|---|
max_questions_per_hour | google.protobuf.Int64Value Максимально допустимое число вопросов в час. Минимальная значение — 0. |
max_updates_per_hour | google.protobuf.Int64Value Максимально допустимое число апдейтов в час. Минимальная значение — 0. |
max_connections_per_hour | google.protobuf.Int64Value Максимально допустимое число коннектов в час. Минимальная значение — 0. |
max_user_connections | google.protobuf.Int64Value Максимально допустимое число коннектов. Минимальная значение — 0. |
HostSpec
Поле | Описание |
---|---|
zone_id | string Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List. Максимальная длина строки в символах — 50. |
subnet_id | string Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети задан в поле Cluster.network_id. Максимальная длина строки в символах — 50. |
assign_public_ip | bool
|
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 Идентификатор создаваемого кластера MySQL. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера MySQL. Этот идентификатор Managed Service for MySQL генерирует при создании. |
folder_id | string Идентификатор каталога, которому принадлежит кластер MySQL. |
created_at | google.protobuf.Timestamp |
name | string Имя кластера MySQL. Имя должно быть уникальным в каталоге, соответствовать RFC 1035 и иметь длину 1-63 символа. |
description | string Описание кластера MySQL. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера MySQL в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания кластера MySQL.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру MySQL. |
config | ClusterConfig Конфигурация кластера MySQL. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Агрегированная работоспособность кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для кластера MySQL. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения MySQL. |
mysql_config | oneof: mysql_config_5_7 или mysql_config_8_0 Конфигурация для серверов MySQL в кластере. |
mysql_config_5_7 | config.MysqlConfigSet5_7 Конфигурация сервера MySQL 5.7. |
mysql_config_8_0 | config.MysqlConfigSet8_0 Конфигурация сервера MySQL 8.0. |
resources | Resources Ресурсы, выделенные хостам MySQL. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
Update
Изменяет указанный кластер MySQL.
rpc Update (UpdateClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateClusterMetadata
Operation.response:Cluster
UpdateClusterRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера MySQL, который следует изменить. Чтобы получить идентификатор MySQL кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
update_mask | google.protobuf.FieldMask Маска, которая указывает, какие атрибуты кластера MySQL должны быть изменены. |
description | string Новое описание кластера MySQL. Максимальная длина строки в символах — 256. |
labels | map<string,string> Пользовательские метки для кластера MySQL в виде пар key:value . Максимум 64 на ресурс. Например, "project": "mvp" или "source": "dictionary". Новый набор меток полностью заменит старый. Чтобы добавить метку, запросите текущий набор меток с помощью метода ClusterService.Get, затем отправьте запрос ClusterService.Update, добавив новую метку в этот набор. Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
config_spec | ConfigSpec Новая конфигурация и ресурсы для хостов кластера. |
name | string Новое имя кластера. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]* . |
ConfigSpec
Поле | Описание |
---|---|
version | string
|
mysql_config | oneof: mysql_config_5_7 или mysql_config_8_0 Конфигурация кластера MySQL. |
mysql_config_5_7 | config.MysqlConfig5_7 Конфигурация для кластера MySQL 5.7. |
mysql_config_8_0 | config.MysqlConfig8_0 Конфигурация для кластера MySQL 8.0. |
resources | Resources Ресурсы, выделенные хостам MySQL. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД. |
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 Идентификатор изменяемого кластера MySQL. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера MySQL. Этот идентификатор Managed Service for MySQL генерирует при создании. |
folder_id | string Идентификатор каталога, которому принадлежит кластер MySQL. |
created_at | google.protobuf.Timestamp |
name | string Имя кластера MySQL. Имя должно быть уникальным в каталоге, соответствовать RFC 1035 и иметь длину 1-63 символа. |
description | string Описание кластера MySQL. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера MySQL в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания кластера MySQL.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру MySQL. |
config | ClusterConfig Конфигурация кластера MySQL. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Агрегированная работоспособность кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для кластера MySQL. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения MySQL. |
mysql_config | oneof: mysql_config_5_7 или mysql_config_8_0 Конфигурация для серверов MySQL в кластере. |
mysql_config_5_7 | config.MysqlConfigSet5_7 Конфигурация сервера MySQL 5.7. |
mysql_config_8_0 | config.MysqlConfigSet8_0 Конфигурация сервера MySQL 8.0. |
resources | Resources Ресурсы, выделенные хостам MySQL. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
Delete
Удаляет указанный кластер MySQL.
rpc Delete (DeleteClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:DeleteClusterMetadata
Operation.response:google.protobuf.Empty
DeleteClusterRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера MySQL, который следует удалить. Чтобы получить идентификатор MySQL кластера, используйте запрос 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 Идентификатор удаляемого кластера MySQL. |
Start
Запускает указанный кластер MySQL.
rpc Start (StartClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:StartClusterMetadata
Operation.response:Cluster
StartClusterRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера MySQL, который следует запустить. Максимальная длина строки в символах — 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 Идентификатор запускаемого кластера MySQL. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера MySQL. Этот идентификатор Managed Service for MySQL генерирует при создании. |
folder_id | string Идентификатор каталога, которому принадлежит кластер MySQL. |
created_at | google.protobuf.Timestamp |
name | string Имя кластера MySQL. Имя должно быть уникальным в каталоге, соответствовать RFC 1035 и иметь длину 1-63 символа. |
description | string Описание кластера MySQL. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера MySQL в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания кластера MySQL.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру MySQL. |
config | ClusterConfig Конфигурация кластера MySQL. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Агрегированная работоспособность кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для кластера MySQL. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения MySQL. |
mysql_config | oneof: mysql_config_5_7 или mysql_config_8_0 Конфигурация для серверов MySQL в кластере. |
mysql_config_5_7 | config.MysqlConfigSet5_7 Конфигурация сервера MySQL 5.7. |
mysql_config_8_0 | config.MysqlConfigSet8_0 Конфигурация сервера MySQL 8.0. |
resources | Resources Ресурсы, выделенные хостам MySQL. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
Stop
Останавливает указанный кластер MySQL.
rpc Stop (StopClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:StopClusterMetadata
Operation.response:Cluster
StopClusterRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера MySQL, который следует остановить. Максимальная длина строки в символах — 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 Идентификатор останавливаемого кластера MySQL. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера MySQL. Этот идентификатор Managed Service for MySQL генерирует при создании. |
folder_id | string Идентификатор каталога, которому принадлежит кластер MySQL. |
created_at | google.protobuf.Timestamp |
name | string Имя кластера MySQL. Имя должно быть уникальным в каталоге, соответствовать RFC 1035 и иметь длину 1-63 символа. |
description | string Описание кластера MySQL. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера MySQL в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания кластера MySQL.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру MySQL. |
config | ClusterConfig Конфигурация кластера MySQL. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Агрегированная работоспособность кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для кластера MySQL. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения MySQL. |
mysql_config | oneof: mysql_config_5_7 или mysql_config_8_0 Конфигурация для серверов MySQL в кластере. |
mysql_config_5_7 | config.MysqlConfigSet5_7 Конфигурация сервера MySQL 5.7. |
mysql_config_8_0 | config.MysqlConfigSet8_0 Конфигурация сервера MySQL 8.0. |
resources | Resources Ресурсы, выделенные хостам MySQL. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
Move
Перемещает кластер MySQL в указанный каталог.
rpc Move (MoveClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:MoveClusterMetadata
Operation.response:Cluster
MoveClusterRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера MySQL, который следует переместить. Максимальная длина строки в символах — 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 Идентификатор перемещаемого кластера MySQL. |
source_folder_id | string Идентификатор исходного каталога. |
destination_folder_id | string Идентификатор каталога назначения. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера MySQL. Этот идентификатор Managed Service for MySQL генерирует при создании. |
folder_id | string Идентификатор каталога, которому принадлежит кластер MySQL. |
created_at | google.protobuf.Timestamp |
name | string Имя кластера MySQL. Имя должно быть уникальным в каталоге, соответствовать RFC 1035 и иметь длину 1-63 символа. |
description | string Описание кластера MySQL. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера MySQL в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания кластера MySQL.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру MySQL. |
config | ClusterConfig Конфигурация кластера MySQL. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Агрегированная работоспособность кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для кластера MySQL. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения MySQL. |
mysql_config | oneof: mysql_config_5_7 или mysql_config_8_0 Конфигурация для серверов MySQL в кластере. |
mysql_config_5_7 | config.MysqlConfigSet5_7 Конфигурация сервера MySQL 5.7. |
mysql_config_8_0 | config.MysqlConfigSet8_0 Конфигурация сервера MySQL 8.0. |
resources | Resources Ресурсы, выделенные хостам MySQL. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
Backup
Создает резервную копию для указанного кластера MySQL.
rpc Backup (BackupClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:BackupClusterMetadata
Operation.response:Cluster
BackupClusterRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера MySQL, для которого следует создать резервную копию. Чтобы получить идентификатор MySQL кластера, используйте запрос 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 Идентификатор кластера MySQL, для которого выполняется резервное копирование. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера MySQL. Этот идентификатор Managed Service for MySQL генерирует при создании. |
folder_id | string Идентификатор каталога, которому принадлежит кластер MySQL. |
created_at | google.protobuf.Timestamp |
name | string Имя кластера MySQL. Имя должно быть уникальным в каталоге, соответствовать RFC 1035 и иметь длину 1-63 символа. |
description | string Описание кластера MySQL. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера MySQL в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания кластера MySQL.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру MySQL. |
config | ClusterConfig Конфигурация кластера MySQL. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Агрегированная работоспособность кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для кластера MySQL. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения MySQL. |
mysql_config | oneof: mysql_config_5_7 или mysql_config_8_0 Конфигурация для серверов MySQL в кластере. |
mysql_config_5_7 | config.MysqlConfigSet5_7 Конфигурация сервера MySQL 5.7. |
mysql_config_8_0 | config.MysqlConfigSet8_0 Конфигурация сервера MySQL 8.0. |
resources | Resources Ресурсы, выделенные хостам MySQL. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
Restore
Создает новый кластер MySQL с использованием указанной резервной копии.
rpc Restore (RestoreClusterRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:RestoreClusterMetadata
Operation.response:Cluster
RestoreClusterRequest
Поле | Описание |
---|---|
backup_id | string Обязательное поле. Идентификатор резервной копии, из которой следует создать кластер. Чтобы получить идентификатор резервной копии, используйте запрос ClusterService.ListBackups. |
time | google.protobuf.Timestamp Обязательное поле. Момент времени, на который должен быть восстановлен кластер MySQL. |
name | string Обязательное поле. Имя нового кластера MySQL. Имя должно быть уникальным в каталоге. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]* . |
description | string Описание нового кластера MySQL. Максимальная длина строки в символах — 256. |
labels | map<string,string> Пользовательские метки для кластера MySQL в виде пар key:value . Максимум 64 на ресурс. Например, "project": "mvp" или "source": "dictionary". Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
environment | Cluster.Environment Среда развертывания для нового кластера MySQL. |
config_spec | ConfigSpec Конфигурация для создаваемого кластера MySQL. |
host_specs[] | HostSpec Конфигурации для хостов MySQL, которые должны быть добавлены к кластеру, создаваемогму из резервной копии. |
network_id | string Идентификатор сети, в которой нужно создать кластер MySQL. Максимальная длина строки в символах — 50. |
folder_id | string Идентификатор каталога, в котором нужно создать кластер MySQL. Максимальная длина строки в символах — 50. |
ConfigSpec
Поле | Описание |
---|---|
version | string
|
mysql_config | oneof: mysql_config_5_7 или mysql_config_8_0 Конфигурация кластера MySQL. |
mysql_config_5_7 | config.MysqlConfig5_7 Конфигурация для кластера MySQL 5.7. |
mysql_config_8_0 | config.MysqlConfig8_0 Конфигурация для кластера MySQL 8.0. |
resources | Resources Ресурсы, выделенные хостам MySQL. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД. |
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
|
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 Идентификатор нового кластера MySQL, создаваемого из резервной копии. |
backup_id | string Идентификатор резервной копии, используемой для создания кластера. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера MySQL. Этот идентификатор Managed Service for MySQL генерирует при создании. |
folder_id | string Идентификатор каталога, которому принадлежит кластер MySQL. |
created_at | google.protobuf.Timestamp |
name | string Имя кластера MySQL. Имя должно быть уникальным в каталоге, соответствовать RFC 1035 и иметь длину 1-63 символа. |
description | string Описание кластера MySQL. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера MySQL в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания кластера MySQL.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру MySQL. |
config | ClusterConfig Конфигурация кластера MySQL. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Агрегированная работоспособность кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для кластера MySQL. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения MySQL. |
mysql_config | oneof: mysql_config_5_7 или mysql_config_8_0 Конфигурация для серверов MySQL в кластере. |
mysql_config_5_7 | config.MysqlConfigSet5_7 Конфигурация сервера MySQL 5.7. |
mysql_config_8_0 | config.MysqlConfigSet8_0 Конфигурация сервера MySQL 8.0. |
resources | Resources Ресурсы, выделенные хостам MySQL. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
StartFailover
Запускает ручное переключение мастера для указанного кластера MySQL.
rpc StartFailover (StartClusterFailoverRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:StartClusterFailoverMetadata
Operation.response:Cluster
StartClusterFailoverRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера MySQL. Максимальная длина строки в символах — 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 Идентификатор кластера MySQL, для которого переключается мастер. |
Cluster
Поле | Описание |
---|---|
id | string Идентификатор кластера MySQL. Этот идентификатор Managed Service for MySQL генерирует при создании. |
folder_id | string Идентификатор каталога, которому принадлежит кластер MySQL. |
created_at | google.protobuf.Timestamp |
name | string Имя кластера MySQL. Имя должно быть уникальным в каталоге, соответствовать RFC 1035 и иметь длину 1-63 символа. |
description | string Описание кластера MySQL. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Пользовательские метки для кластера MySQL в виде пар key:value . Максимум 64 на ресурс. |
environment | enum Environment Среда развертывания кластера MySQL.
|
monitoring[] | Monitoring Описание систем мониторинга, относящихся к данному кластеру MySQL. |
config | ClusterConfig Конфигурация кластера MySQL. |
network_id | string Идентификатор сети, к которой принадлежит кластер. |
health | enum Health Агрегированная работоспособность кластера.
|
status | enum Status Текущее состояние кластера.
|
Monitoring
Поле | Описание |
---|---|
name | string Название системы мониторинга. |
description | string Описание системы мониторинга. |
link | string Ссылка на графики системы мониторинга для кластера MySQL. |
ClusterConfig
Поле | Описание |
---|---|
version | string Версия серверного программного обеспечения MySQL. |
mysql_config | oneof: mysql_config_5_7 или mysql_config_8_0 Конфигурация для серверов MySQL в кластере. |
mysql_config_5_7 | config.MysqlConfigSet5_7 Конфигурация сервера MySQL 5.7. |
mysql_config_8_0 | config.MysqlConfigSet8_0 Конфигурация сервера MySQL 8.0. |
resources | Resources Ресурсы, выделенные хостам MySQL. |
backup_window_start | google.type.TimeOfDay Время запуска ежедневного резервного копирования, в часовом поясе UTC. |
access | Access Политика доступа к БД |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту. |
disk_type_id | string
|
Access
Поле | Описание |
---|---|
data_lens | bool Разрешить доступ для DataLens |
ListLogs
Получает логи для указанного кластера MySQL.
rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)
ListClusterLogsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера MySQL, для которого следует запросить логи. Чтобы получить идентификатор MySQL кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
column_filter[] | string Столбцы из таблицы логов для запроса. Если столбцы не указаны, записи логов возвращаются целиком. |
service_type | enum ServiceType Тип сервиса, для которого следует запросить логи.
|
from_time | google.protobuf.Timestamp Начало периода, для которого следует запросить логи. |
to_time | google.protobuf.Timestamp Конец периода, для которого следует запросить логи. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListClusterLogsResponse.next_page_token, которое можно использовать для получения следующей страницы. Допустимые значения — от 0 до 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
Возвращает список операций для указанного кластера MySQL.
rpc ListOperations (ListClusterOperationsRequest) returns (ListClusterOperationsResponse)
ListClusterOperationsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера MySQL, для которого запрашивается список операций. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListClusterOperationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Допустимые значения — от 0 до 1000 включительно. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListClusterOperationsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
ListClusterOperationsResponse
Поле | Описание |
---|---|
operations[] | operation.Operation Список операций для указанного кластера MySQL. |
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
Получает список доступных резервных копий для указанного кластера MySQL.
rpc ListBackups (ListClusterBackupsRequest) returns (ListClusterBackupsResponse)
ListClusterBackupsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера MySQL. Чтобы получить идентификатор MySQL кластера, используйте запрос 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 Список резервных копий MySQL. |
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 |
source_cluster_id | string Идентификатор кластера MySQL, для которого была создана резервная копия. |
started_at | google.protobuf.Timestamp Время запуска операции резервного копирования. |
ListHosts
Получает список хостов для указанного кластера MySQL.
rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)
ListClusterHostsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера MySQL. Чтобы получить идентификатор MySQL кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListClusterHostsResponse.next_page_token, которое можно использовать для получения следующей страницы. Допустимые значения — от 0 до 1000 включительно. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListClusterHostsResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
ListClusterHostsResponse
Поле | Описание |
---|---|
hosts[] | Host Список хостов MySQL. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListClusterHostsRequest.page_size, используйте next_page_token в качестве значения параметра ListClusterHostsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
Host
Поле | Описание |
---|---|
name | string Имя хоста MySQL. Имя хоста Managed Service for MySQL назначает во время создания, его нельзя изменить. Длина 1-63 символов. Имя уникально для всех существующих хостов баз данных в Яндекс.Облаке, так как оно определяет полное доменное имя (FQDN) хоста. |
cluster_id | string Идентификатор хоста MySQL. Этот идентификатор Managed Service for MySQL генерирует при создании. |
zone_id | string Идентификатор зоны доступности, в которой находится хост MySQL. |
resources | Resources Ресурсы, выделенные хосту. |
role | enum Role Роль хоста в кластере.
|
health | enum Health Код работоспособности хоста.
|
services[] | Service Сервисы, предоставляемые хостом. |
subnet_id | string Идентификатор подсети, к которой принадлежит хост. |
assign_public_ip | bool Флаг, показывающий статус публичного IP-адреса для этого хоста. |
Resources
Поле | Описание |
---|---|
resource_preset_id | string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
disk_size | int64 Объем хранилища, доступного хосту. |
disk_type_id | string
|
Service
Поле | Описание |
---|---|
type | enum Type Тип сервиса, предоставляемого хостом.
|
health | enum Health Код состояния доступности сервера.
|
AddHosts
Создает новые хосты для кластера.
rpc AddHosts (AddClusterHostsRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:AddClusterHostsMetadata
Operation.response:google.protobuf.Empty
AddClusterHostsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера MySQL, для которого следует добавить хосты. Чтобы получить идентификатор MySQL кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
host_specs[] | HostSpec Конфигурации для хостов MySQL, которые должны быть добавлены в кластер. Количество элементов должно быть больше 0. |
HostSpec
Поле | Описание |
---|---|
zone_id | string Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List. Максимальная длина строки в символах — 50. |
subnet_id | string Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети задан в поле Cluster.network_id. Максимальная длина строки в символах — 50. |
assign_public_ip | bool
|
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 Идентификатор кластера MySQL, в который добавляются хосты. |
host_names[] | string Имена хостов, добавляемых в кластер. |
DeleteHosts
Удаляет указанные хосты кластера.
rpc DeleteHosts (DeleteClusterHostsRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:DeleteClusterHostsMetadata
Operation.response:google.protobuf.Empty
DeleteClusterHostsRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера MySQL, из которого следует удалить хосты. Чтобы получить идентификатор MySQL кластера, используйте запрос 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 Идентификатор кластера MySQL, из которого следует удалить хосты. |
host_names[] | string Имена удаляемых хостов. |