Метод list

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

Возвращает список кластеров MySQL, принадлежащих указанному каталогу.

HTTP-запрос

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

Query-параметры

Параметр	Описание
folderId	Обязательное поле. Идентификатор каталога, для которого нужно получить список кластеров MySQL. Чтобы получить идентификатор каталога, используйте запрос list. Максимальная длина строки в символах — 50.
pageSize	Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Допустимые значения — от 0 до 1000 включительно.
pageToken	Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
filter	Параметры фильтрации ресурсов в ответе. В параметрах фильтрации указываются: 1. Имя поля. В настоящее время фильтрацию можно использовать только с полем Cluster.name. 2. Оператор. Операторы `=` или `!=` для одиночных значений, `IN` или `NOT IN` для списков значений. 3. Значение. Должен содержать от 1 до 63 символов и соответствовать регулярному выражению `^[a-zA-Z0-9_-]+$`. Максимальная длина строки в символах — 1000.

Ответ

HTTP Code: 200 - OK

{
  "clusters": [
    {
      "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"
    }
  ],
  "nextPageToken": "string"
}

Поле	Описание
clusters[]	object Кластер MySQL. Подробнее см. в документации.
clusters[]. id	string Идентификатор кластера MySQL. Этот идентификатор Managed Service for MySQL генерирует при создании.
clusters[]. folderId	string Идентификатор каталога, которому принадлежит кластер MySQL.
clusters[]. createdAt	string (date-time) Строка в формате RFC3339.
clusters[]. name	string Имя кластера MySQL. Имя должно быть уникальным в каталоге, соответствовать RFC 1035 и иметь длину 1-63 символа.
clusters[]. description	string Описание кластера MySQL. Длина описания должна быть от 0 до 256 символов.
clusters[]. labels	object Пользовательские метки для кластера MySQL в виде пар `key:value`. Максимум 64 на ресурс.
clusters[]. environment	string Среда развертывания кластера MySQL. PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления. PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
clusters[]. monitoring[]	object Описание систем мониторинга, относящихся к данному кластеру MySQL.
clusters[]. monitoring[]. name	string Название системы мониторинга.
clusters[]. monitoring[]. description	string Описание системы мониторинга.
clusters[]. monitoring[]. link	string Ссылка на графики системы мониторинга для кластера MySQL.
clusters[]. config	object Конфигурация кластера MySQL.
clusters[]. config. version	string Версия серверного программного обеспечения MySQL.
clusters[]. config. resources	object Ресурсы, выделенные хостам MySQL.
clusters[]. config. resources. resourcePresetId	string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
clusters[]. config. resources. diskSize	string (int64) Объем хранилища, доступного хосту.
clusters[]. config. resources. diskTypeId	string Тип хранилища для хоста. Возможные значения: network-ssd — сетевой SSD-диск; local-ssd — локальное SSD-хранилище.
clusters[]. config. backupWindowStart	object Время запуска ежедневного резервного копирования, в часовом поясе UTC. Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.
clusters[]. config. backupWindowStart. hours	integer (int32) Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
clusters[]. config. backupWindowStart. minutes	integer (int32) Minutes of hour of day. Must be from 0 to 59.
clusters[]. config. backupWindowStart. seconds	integer (int32) Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
clusters[]. config. backupWindowStart. nanos	integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
clusters[]. config. mysqlConfig_5_7	object Конфигурация сервера MySQL 5.7.
clusters[]. config. mysqlConfig_5_7. effectiveConfig	object Действующие параметры для кластера MySQL 5.7 (сочетание параметров, определенных в `userConfig` и `defaultConfig`). Поля и структура `MysqlConfig5_7` отражает параметры конфигурации MySQL 5.7.
clusters[]. config. mysqlConfig_5_7. effectiveConfig. innodbBufferPoolSize	integer (int64) Размер буфера InnoDB, который используется для кэширования данных таблиц и индексов. Подробнее см. в описании переменной в документации MySQL. Минимальное значение — 5242880.
clusters[]. config. mysqlConfig_5_7. effectiveConfig. maxConnections	integer (int64) Максимальное количество одновременных подключений, которые принимает MySQL. Подробнее см. в описании переменной в документации MySQL. Допустимые значения — от 10 до 10000 включительно.
clusters[]. config. mysqlConfig_5_7. effectiveConfig. longQueryTime	number (double) Время, в течение которого запрос должен обрабатываться, прежде чем он начинает считаться медленным. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_5_7. userConfig	object Пользовательские настройки для кластера MySQL 5.7. Поля и структура `MysqlConfig5_7` отражает параметры конфигурации MySQL 5.7.
clusters[]. config. mysqlConfig_5_7. userConfig. innodbBufferPoolSize	integer (int64) Размер буфера InnoDB, который используется для кэширования данных таблиц и индексов. Подробнее см. в описании переменной в документации MySQL. Минимальное значение — 5242880.
clusters[]. config. mysqlConfig_5_7. userConfig. maxConnections	integer (int64) Максимальное количество одновременных подключений, которые принимает MySQL. Подробнее см. в описании переменной в документации MySQL. Допустимые значения — от 10 до 10000 включительно.
clusters[]. config. mysqlConfig_5_7. userConfig. longQueryTime	number (double) Время, в течение которого запрос должен обрабатываться, прежде чем он начинает считаться медленным. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_5_7. defaultConfig	object Конфигурация по умолчанию для кластера MySQL 5.7. Поля и структура `MysqlConfig5_7` отражает параметры конфигурации MySQL 5.7.
clusters[]. config. mysqlConfig_5_7. defaultConfig. innodbBufferPoolSize	integer (int64) Размер буфера InnoDB, который используется для кэширования данных таблиц и индексов. Подробнее см. в описании переменной в документации MySQL. Минимальное значение — 5242880.
clusters[]. config. mysqlConfig_5_7. defaultConfig. maxConnections	integer (int64) Максимальное количество одновременных подключений, которые принимает MySQL. Подробнее см. в описании переменной в документации MySQL. Допустимые значения — от 10 до 10000 включительно.
clusters[]. config. mysqlConfig_5_7. defaultConfig. longQueryTime	number (double) Время, в течение которого запрос должен обрабатываться, прежде чем он начинает считаться медленным. Подробнее см. в описании переменной в документации MySQL.
clusters[]. networkId	string Идентификатор сети, к которой принадлежит кластер.
clusters[]. health	string Агрегированная работоспособность кластера. HEALTH_UNKNOWN: Состояние кластера неизвестно (`health` для каждого хоста в кластере — UNKNOWN). ALIVE: Кластер работает нормально (`health` для каждого хоста в кластере — ALIVE). DEAD: Кластер не работает (`health` для каждого узла в кластере — DEAD). DEGRADED: Кластер работает неоптимально (`health` по крайней мере для одного узла в кластере не ALIVE).
clusters[]. status	string Текущее состояние кластера. STATUS_UNKNOWN: Состояние кластера неизвестно. CREATING: Кластер создается. RUNNING: Кластер работает нормально. ERROR: На кластере произошла ошибка, блокирующая работу. UPDATING: Кластер изменяется. STOPPING: Кластер останавливается. STOPPED: Кластер остановлен. STARTING: Кластер запускается.
nextPageToken	string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов.