Метод get

HTTP-запрос
Path-параметры
Ответ

Возвращает указанный кластер MySQL.

Чтобы получить список доступных кластеров MySQL, выполните запрос list.

HTTP-запрос

GET https://mdb.api.cloud.yandex.net/managed-mysql/v1alpha/clusters/{clusterId}

Path-параметры

Параметр	Описание
clusterId	Обязательное поле. Идентификатор возвращаемого кластера MySQL. Чтобы получить идентификатор кластера, используйте запрос list. Максимальная длина строки в символах — 50.

Ответ

HTTP Code: 200 - OK

{
  "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"
      },
      "userConfig": {
        "innodbBufferPoolSize": "integer",
        "maxConnections": "integer",
        "longQueryTime": "number"
      },
      "defaultConfig": {
        "innodbBufferPoolSize": "integer",
        "maxConnections": "integer",
        "longQueryTime": "number"
      }
    }
  },
  "networkId": "string",
  "health": "string",
  "status": "string"
}

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

Поле	Описание
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 Ресурсы, выделенные хостам MySQL.
config. resources. resourcePresetId	string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
config. resources. diskSize	string (int64) Объем хранилища, доступного хосту.
config. resources. diskTypeId	string Тип хранилища для хоста. Возможные значения: network-ssd — сетевой SSD-диск; local-ssd — локальное SSD-хранилище.
config. backupWindowStart	object Время запуска ежедневного резервного копирования, в часовом поясе UTC. Время суток. Дата и часовой пояс либо не учитываются, либо задаются в других местах. API может разрешить использование високосной секунды. Связанные типы: google.type.Date и google.protobuf.Timestamp.
config. backupWindowStart. hours	integer (int32) Часы. Допустимые значения: от 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 до 999999999.
config. mysqlConfig_5_7	object Конфигурация сервера MySQL 5.7.
config. mysqlConfig_5_7. effectiveConfig	object Действующие параметры для кластера MySQL 5.7 (сочетание параметров, определенных в `userConfig` и `defaultConfig`). Поля и структура `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.
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.
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.
networkId	string Идентификатор сети, к которой принадлежит кластер.
health	string Агрегированная работоспособность кластера. HEALTH_UNKNOWN: Состояние кластера неизвестно (`health` для каждого хоста в кластере — UNKNOWN). ALIVE: Кластер работает нормально (`health` для каждого хоста в кластере — ALIVE). DEAD: Кластер не работает (`health` для каждого узла в кластере — DEAD). DEGRADED: Кластер работает неоптимально (`health` по крайней мере для одного узла в кластере не ALIVE).
status	string Текущее состояние кластера. STATUS_UNKNOWN: Состояние кластера неизвестно. CREATING: Кластер создается. RUNNING: Кластер работает нормально. ERROR: На кластере произошла ошибка, блокирующая работу. UPDATING: Кластер изменяется. STOPPING: Кластер останавливается. STOPPED: Кластер остановлен. STARTING: Кластер запускается.