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

Cluster

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

JSON-представление

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "environment": "string",
  "monitoring": [
    {
      "name": "string",
      "description": "string",
      "link": "string"
    }
  ],
  "config": {
    "version": "string",
    "resources": {
      "resourcePresetId": "string",
      "diskSize": "string",
      "diskTypeId": "string"
    },
    "backupWindowStart": {
      "hours": "integer",
      "minutes": "integer",
      "seconds": "integer",
      "nanos": "integer"
    },
    "mysqlConfig_5_7": {
      "effectiveConfig": {
        "innodbBufferPoolSize": "integer",
        "maxConnections": "integer",
        "longQueryTime": "number",
        "generalLog": true,
        "auditLog": true,
        "sqlMode": [
          "string"
        ],
        "maxAllowedPacket": "integer",
        "defaultAuthenticationPlugin": "string"
      },
      "userConfig": {
        "innodbBufferPoolSize": "integer",
        "maxConnections": "integer",
        "longQueryTime": "number",
        "generalLog": true,
        "auditLog": true,
        "sqlMode": [
          "string"
        ],
        "maxAllowedPacket": "integer",
        "defaultAuthenticationPlugin": "string"
      },
      "defaultConfig": {
        "innodbBufferPoolSize": "integer",
        "maxConnections": "integer",
        "longQueryTime": "number",
        "generalLog": true,
        "auditLog": true,
        "sqlMode": [
          "string"
        ],
        "maxAllowedPacket": "integer",
        "defaultAuthenticationPlugin": "string"
      }
    }
  },
  "networkId": "string",
  "health": "string",
  "status": "string"
}
Поле Описание
id string

Идентификатор кластера MySQL. Этот идентификатор Managed Service for MySQL генерирует при создании.
folderId string

Идентификатор каталога, которому принадлежит кластер MySQL.
createdAt string (date-time)

Строка в формате RFC3339.
name string

Имя кластера MySQL. Имя должно быть уникальным в каталоге, соответствовать RFC 1035 и иметь длину 1-63 символа.
description string

Описание кластера MySQL. Длина описания должна быть от 0 до 256 символов.
labels object

Пользовательские метки для кластера MySQL в виде пар key:value. Максимум 64 на ресурс.
environment string

Среда развертывания кластера MySQL.

  • PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления.
  • PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
monitoring[] object

Описание систем мониторинга, относящихся к данному кластеру MySQL.
monitoring[].
name		 string

Название системы мониторинга.
monitoring[].
description		 string

Описание системы мониторинга.
monitoring[].
link		 string

Ссылка на графики системы мониторинга для кластера MySQL.
config object

Конфигурация кластера MySQL.
config.
version		 string

Версия серверного программного обеспечения MySQL.
config.
resources		 object
config.
resources.
resourcePresetId		 string

Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
config.
resources.
diskSize		 string (int64)

Объем хранилища, доступного хосту.
config.
resources.
diskTypeId		 string

Тип хранилища для хоста. Возможные значения:

  • network-ssd — сетевой SSD-диск;
  • local-ssd — локальное SSD-хранилище.
config.
backupWindowStart		 object

Описывает время суток. Дата и часовой пояс либо не имеют значения, либо указаны другим образом. API может разрешить високосные секунды. Связанные типы: [google.type.Date][google.type.Date] и google.protobuf.Timestamp.
config.
backupWindowStart.
hours		 integer (int32)

Час в 24-часовом формате. Допустимые значения — от 0 до 23. API может разрешить значение "24:00:00" для таких сценариев, как время закрытия заведения.
config.
backupWindowStart.
minutes		 integer (int32)

Минута часа. Допустимые значения — от 0 до 59.
config.
backupWindowStart.
seconds		 integer (int32)

Секунда минуты. Обычно допустимые значения — от 0 до 59. API может разрешить значение 60, если поддерживаются високосные секунды.
config.
backupWindowStart.
nanos		 integer (int32)

Доли секунды, в наносекундах. Допустимые значения — от 0 до 999 999 999.
config.
mysqlConfig_5_7		 object
config.
mysqlConfig_5_7.
effectiveConfig		 object

Действующие параметры для кластера MySQL 5.7 (сочетание параметров, определенных в userConfig и [default_config]).

Поля и структура MysqlConfig5_7 отражает параметры конфигурации MySQL 5.7.
config.
mysqlConfig_5_7.
effectiveConfig.
innodbBufferPoolSize		 integer (int64)

Размер буфера InnoDB, который используется для кэширования данных таблиц и индексов.

Подробнее см. в описании параметра в документации MySQL.

Минимальное значение — 5242880.
config.
mysqlConfig_5_7.
effectiveConfig.
maxConnections		 integer (int64)

Максимальное количество одновременных подключений, которые принимает MySQL.

Подробнее см. в описании переменной в документации MySQL.

Допустимые значения — от 10 до 10000 включительно.
config.
mysqlConfig_5_7.
effectiveConfig.
longQueryTime		 number (double)

Время, в течение которого запрос должен обрабатываться, прежде чем он начинает считаться медленным.

Подробнее см. в MySQL documentation for the variable.
config.
mysqlConfig_5_7.
effectiveConfig.
generalLog		 boolean (boolean)

Включить запись общего лога запросов MySQL.

Подробнее см. в описании переменной в документации MySQL.
config.
mysqlConfig_5_7.
effectiveConfig.
auditLog		 boolean (boolean)

Включить запись лога аудита MySQL.

Подробнее см. в описании переменной в документации MySQL.
config.
mysqlConfig_5_7.
effectiveConfig.
sqlMode[]		 string

Режим SQL для сервера MySQL.

Подробнее см. в описании переменной в документации MySQL.
config.
mysqlConfig_5_7.
effectiveConfig.
maxAllowedPacket		 integer (int64)

Максимальный размер одного пакета в байтах.

Подробнее см. в описании переменной в документации MySQL.

Допустимые значения — от 1024 до 134217728 включительно.
config.
mysqlConfig_5_7.
effectiveConfig.
defaultAuthenticationPlugin		 string
config.
mysqlConfig_5_7.
userConfig		 object

Пользовательские настройки для кластера MySQL 5.7.

Поля и структура MysqlConfig5_7 отражает параметры конфигурации MySQL 5.7.
config.
mysqlConfig_5_7.
userConfig.
innodbBufferPoolSize		 integer (int64)

Размер буфера InnoDB, который используется для кэширования данных таблиц и индексов.

Подробнее см. в описании параметра в документации MySQL.

Минимальное значение — 5242880.
config.
mysqlConfig_5_7.
userConfig.
maxConnections		 integer (int64)

Максимальное количество одновременных подключений, которые принимает MySQL.

Подробнее см. в описании переменной в документации MySQL.

Допустимые значения — от 10 до 10000 включительно.
config.
mysqlConfig_5_7.
userConfig.
longQueryTime		 number (double)

Время, в течение которого запрос должен обрабатываться, прежде чем он начинает считаться медленным.

Подробнее см. в MySQL documentation for the variable.
config.
mysqlConfig_5_7.
userConfig.
generalLog		 boolean (boolean)

Включить запись общего лога запросов MySQL.

Подробнее см. в описании переменной в документации MySQL.
config.
mysqlConfig_5_7.
userConfig.
auditLog		 boolean (boolean)

Включить запись лога аудита MySQL.

Подробнее см. в описании переменной в документации MySQL.
config.
mysqlConfig_5_7.
userConfig.
sqlMode[]		 string

Режим SQL для сервера MySQL.

Подробнее см. в описании переменной в документации MySQL.
config.
mysqlConfig_5_7.
userConfig.
maxAllowedPacket		 integer (int64)

Максимальный размер одного пакета в байтах.

Подробнее см. в описании переменной в документации MySQL.

Допустимые значения — от 1024 до 134217728 включительно.
config.
mysqlConfig_5_7.
userConfig.
defaultAuthenticationPlugin		 string
config.
mysqlConfig_5_7.
defaultConfig		 object

Конфигурация по умолчанию для кластера MySQL 5.7.

Поля и структура MysqlConfig5_7 отражает параметры конфигурации MySQL 5.7.
config.
mysqlConfig_5_7.
defaultConfig.
innodbBufferPoolSize		 integer (int64)

Размер буфера InnoDB, который используется для кэширования данных таблиц и индексов.

Подробнее см. в описании параметра в документации MySQL.

Минимальное значение — 5242880.
config.
mysqlConfig_5_7.
defaultConfig.
maxConnections		 integer (int64)

Максимальное количество одновременных подключений, которые принимает MySQL.

Подробнее см. в описании переменной в документации MySQL.

Допустимые значения — от 10 до 10000 включительно.
config.
mysqlConfig_5_7.
defaultConfig.
longQueryTime		 number (double)

Время, в течение которого запрос должен обрабатываться, прежде чем он начинает считаться медленным.

Подробнее см. в MySQL documentation for the variable.
config.
mysqlConfig_5_7.
defaultConfig.
generalLog		 boolean (boolean)

Включить запись общего лога запросов MySQL.

Подробнее см. в описании переменной в документации MySQL.
config.
mysqlConfig_5_7.
defaultConfig.
auditLog		 boolean (boolean)

Включить запись лога аудита MySQL.

Подробнее см. в описании переменной в документации MySQL.
config.
mysqlConfig_5_7.
defaultConfig.
sqlMode[]		 string

Режим SQL для сервера MySQL.

Подробнее см. в описании переменной в документации MySQL.
config.
mysqlConfig_5_7.
defaultConfig.
maxAllowedPacket		 integer (int64)

Максимальный размер одного пакета в байтах.

Подробнее см. в описании переменной в документации MySQL.

Допустимые значения — от 1024 до 134217728 включительно.
config.
mysqlConfig_5_7.
defaultConfig.
defaultAuthenticationPlugin		 string
networkId string

Идентификатор сети, к которой принадлежит кластер.
health string

Агрегированная работоспособность кластера.

  • HEALTH_UNKNOWN: Состояние кластера неизвестно ([Host.health] для каждого хоста в кластере — UNKNOWN).
  • ALIVE: Кластер работает нормально ([Host.health] для каждого хоста в кластере — ALIVE).
  • DEAD: Кластер не работает ([Host.health] для каждого узла в кластере — DEAD).
  • DEGRADED: Кластер работает неоптимально ([Host.health] по крайней мере для одного узла в кластере не ALIVE).
status string

Текущее состояние кластера.

  • STATUS_UNKNOWN: Состояние кластера неизвестно.
  • CREATING: Кластер создается.
  • RUNNING: Кластер работает нормально.
  • ERROR: На кластере произошла ошибка, блокирующая работу.
  • UPDATING: Кластер изменяется.
  • STOPPING: Кластер останавливается.
  • STOPPED: Кластер остановлен.
  • STARTING: Кластер запускается.

Методы

Метод Описание
addHosts Создает новые хосты для кластера.
backup Создает резервную копию для указанного кластера MySQL.
create Создает кластер MySQL в указанном каталоге.
delete Удаляет указанный кластер MySQL.
deleteHosts Удаляет указанные хосты кластера.
get Возвращает указанный кластер MySQL.
list Возвращает список кластеров MySQL, принадлежащих указанному каталогу.
listBackups Получает список доступных резервных копий для указанного кластера MySQL.
listHosts Получает список хостов для указанного кластера MySQL.
listLogs Получает логи для указанного кластера MySQL. Дополнительные сведения о логах см. в разделе Логи документации.
listOperations Возвращает список операций для указанного кластера MySQL.
move Перемещает кластер MySQL в указанный каталог.
restore Создает новый кластер MySQL с использованием указанной резервной копии.
start Запускает указанный кластер MySQL.
startFailover Запускает ручное переключение мастера для указанного кластера MySQL.
stop Останавливает указанный кластер MySQL.
update Изменяет указанный кластер MySQL.