Метод list

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

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

HTTP-запрос

GET https://mdb.api.cloud.yandex.net/managed-mysql/v1/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"
        },
        "access": {
          "dataLens": true
        },

        // `clusters[].config` включает только одно из полей `mysqlConfig_5_7`, `mysqlConfig_8_0`
        "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"
          }
        },
        "mysqlConfig_8_0": {
          "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"
          }
        },
        // конец списка возможных полей`clusters[].config`

      },
      "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. Описывает время суток. Дата и часовой пояс либо не имеют значения, либо указаны другим образом. API может разрешить високосные секунды. Связанные типы: [google.type.Date][google.type.Date] и `google.protobuf.Timestamp`.
clusters[]. config. backupWindowStart. hours	integer (int32) Час в 24-часовом формате. Допустимые значения — от 0 до 23. API может разрешить значение "24:00:00" для таких сценариев, как время закрытия заведения.
clusters[]. config. backupWindowStart. minutes	integer (int32) Минута часа. Допустимые значения — от 0 до 59.
clusters[]. config. backupWindowStart. seconds	integer (int32) Секунда минуты. Обычно допустимые значения — от 0 до 59. API может разрешить значение 60, если поддерживаются високосные секунды.
clusters[]. config. backupWindowStart. nanos	integer (int32) Доли секунды, в наносекундах. Допустимые значения — от 0 до 999 999 999.
clusters[]. config. access	object Политика доступа к БД
clusters[]. config. access. dataLens	boolean (boolean) Разрешить доступ для DataLens
clusters[]. config. mysqlConfig_5_7	object Конфигурация сервера MySQL 5.7. `clusters[].config` включает только одно из полей `mysqlConfig_5_7`, `mysqlConfig_8_0`
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. effectiveConfig. generalLog	boolean (boolean) Включить запись общего лога запросов MySQL. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_5_7. effectiveConfig. auditLog	boolean (boolean) Включить запись лога аудита MySQL. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_5_7. effectiveConfig. sqlMode[]	string Режим SQL для сервера MySQL. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_5_7. effectiveConfig. maxAllowedPacket	integer (int64) Максимальный размер одного пакета в байтах. Подробнее см. в описании переменной в документации MySQL. Допустимые значения — от 1024 до 134217728 включительно.
clusters[]. config. mysqlConfig_5_7. effectiveConfig. defaultAuthenticationPlugin	string Плагин аутентификации, используемый в управляемом кластере MySQL. MYSQL_NATIVE_PASSWORD: Использует Native Pluggable Authentication. SHA256_PASSWORD: Использует SHA-256 Pluggable Authentication.
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. userConfig. generalLog	boolean (boolean) Включить запись общего лога запросов MySQL. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_5_7. userConfig. auditLog	boolean (boolean) Включить запись лога аудита MySQL. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_5_7. userConfig. sqlMode[]	string Режим SQL для сервера MySQL. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_5_7. userConfig. maxAllowedPacket	integer (int64) Максимальный размер одного пакета в байтах. Подробнее см. в описании переменной в документации MySQL. Допустимые значения — от 1024 до 134217728 включительно.
clusters[]. config. mysqlConfig_5_7. userConfig. defaultAuthenticationPlugin	string Плагин аутентификации, используемый в управляемом кластере MySQL. MYSQL_NATIVE_PASSWORD: Использует Native Pluggable Authentication. SHA256_PASSWORD: Использует SHA-256 Pluggable Authentication.
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[]. config. mysqlConfig_5_7. defaultConfig. generalLog	boolean (boolean) Включить запись общего лога запросов MySQL. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_5_7. defaultConfig. auditLog	boolean (boolean) Включить запись лога аудита MySQL. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_5_7. defaultConfig. sqlMode[]	string Режим SQL для сервера MySQL. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_5_7. defaultConfig. maxAllowedPacket	integer (int64) Максимальный размер одного пакета в байтах. Подробнее см. в описании переменной в документации MySQL. Допустимые значения — от 1024 до 134217728 включительно.
clusters[]. config. mysqlConfig_5_7. defaultConfig. defaultAuthenticationPlugin	string Плагин аутентификации, используемый в управляемом кластере MySQL. MYSQL_NATIVE_PASSWORD: Использует Native Pluggable Authentication. SHA256_PASSWORD: Использует SHA-256 Pluggable Authentication.
clusters[]. config. mysqlConfig_8_0	object Конфигурация сервера MySQL 8.0. `clusters[].config` включает только одно из полей `mysqlConfig_5_7`, `mysqlConfig_8_0`
clusters[]. config. mysqlConfig_8_0. effectiveConfig	object Действующие параметры для кластера MySQL 8.0 (сочетание параметров, определенных в `userConfig` и `defaultConfig`). Поля и структура `MysqlConfig8_0` отражает параметры конфигурации MySQL 8.0.
clusters[]. config. mysqlConfig_8_0. effectiveConfig. innodbBufferPoolSize	integer (int64) Размер буфера InnoDB, который используется для кэширования данных таблиц и индексов. Подробнее см. в описании переменной в документации MySQL. Минимальное значение — 5242880.
clusters[]. config. mysqlConfig_8_0. effectiveConfig. maxConnections	integer (int64) Максимальное количество одновременных подключений, которые принимает MySQL. Подробнее см. в описании переменной в документации MySQL. Допустимые значения — от 10 до 10000 включительно.
clusters[]. config. mysqlConfig_8_0. effectiveConfig. longQueryTime	number (double) Время, в течение которого запрос должен обрабатываться, прежде чем он начинает считаться медленным. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_8_0. effectiveConfig. generalLog	boolean (boolean) Включить запись общего лога запросов MySQL. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_8_0. effectiveConfig. auditLog	boolean (boolean) Включить запись лога аудита MySQL. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_8_0. effectiveConfig. sqlMode[]	string Режим SQL для сервера MySQL. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_8_0. effectiveConfig. maxAllowedPacket	integer (int64) Максимальный размер одного пакета в байтах. Подробнее см. в описании переменной в документации MySQL. Допустимые значения — от 1024 до 134217728 включительно.
clusters[]. config. mysqlConfig_8_0. effectiveConfig. defaultAuthenticationPlugin	string Плагин аутентификации, используемый в управляемом кластере MySQL. MYSQL_NATIVE_PASSWORD: Использует Native Pluggable Authentication. CACHING_SHA2_PASSWORD: Использует Caching SHA-2 Pluggable Authentication. SHA256_PASSWORD: Использует SHA-256 Pluggable Authentication.
clusters[]. config. mysqlConfig_8_0. userConfig	object Пользовательские настройки для кластера MySQL 8.0. Поля и структура `MysqlConfig8_0` отражает параметры конфигурации MySQL 8.0.
clusters[]. config. mysqlConfig_8_0. userConfig. innodbBufferPoolSize	integer (int64) Размер буфера InnoDB, который используется для кэширования данных таблиц и индексов. Подробнее см. в описании переменной в документации MySQL. Минимальное значение — 5242880.
clusters[]. config. mysqlConfig_8_0. userConfig. maxConnections	integer (int64) Максимальное количество одновременных подключений, которые принимает MySQL. Подробнее см. в описании переменной в документации MySQL. Допустимые значения — от 10 до 10000 включительно.
clusters[]. config. mysqlConfig_8_0. userConfig. longQueryTime	number (double) Время, в течение которого запрос должен обрабатываться, прежде чем он начинает считаться медленным. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_8_0. userConfig. generalLog	boolean (boolean) Включить запись общего лога запросов MySQL. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_8_0. userConfig. auditLog	boolean (boolean) Включить запись лога аудита MySQL. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_8_0. userConfig. sqlMode[]	string Режим SQL для сервера MySQL. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_8_0. userConfig. maxAllowedPacket	integer (int64) Максимальный размер одного пакета в байтах. Подробнее см. в описании переменной в документации MySQL. Допустимые значения — от 1024 до 134217728 включительно.
clusters[]. config. mysqlConfig_8_0. userConfig. defaultAuthenticationPlugin	string Плагин аутентификации, используемый в управляемом кластере MySQL. MYSQL_NATIVE_PASSWORD: Использует Native Pluggable Authentication. CACHING_SHA2_PASSWORD: Использует Caching SHA-2 Pluggable Authentication. SHA256_PASSWORD: Использует SHA-256 Pluggable Authentication.
clusters[]. config. mysqlConfig_8_0. defaultConfig	object Конфигурация по умолчанию для кластера MySQL 8.0. Поля и структура `MysqlConfig8_0` отражает параметры конфигурации MySQL 8.0.
clusters[]. config. mysqlConfig_8_0. defaultConfig. innodbBufferPoolSize	integer (int64) Размер буфера InnoDB, который используется для кэширования данных таблиц и индексов. Подробнее см. в описании переменной в документации MySQL. Минимальное значение — 5242880.
clusters[]. config. mysqlConfig_8_0. defaultConfig. maxConnections	integer (int64) Максимальное количество одновременных подключений, которые принимает MySQL. Подробнее см. в описании переменной в документации MySQL. Допустимые значения — от 10 до 10000 включительно.
clusters[]. config. mysqlConfig_8_0. defaultConfig. longQueryTime	number (double) Время, в течение которого запрос должен обрабатываться, прежде чем он начинает считаться медленным. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_8_0. defaultConfig. generalLog	boolean (boolean) Включить запись общего лога запросов MySQL. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_8_0. defaultConfig. auditLog	boolean (boolean) Включить запись лога аудита MySQL. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_8_0. defaultConfig. sqlMode[]	string Режим SQL для сервера MySQL. Подробнее см. в описании переменной в документации MySQL.
clusters[]. config. mysqlConfig_8_0. defaultConfig. maxAllowedPacket	integer (int64) Максимальный размер одного пакета в байтах. Подробнее см. в описании переменной в документации MySQL. Допустимые значения — от 1024 до 134217728 включительно.
clusters[]. config. mysqlConfig_8_0. defaultConfig. defaultAuthenticationPlugin	string Плагин аутентификации, используемый в управляемом кластере MySQL. MYSQL_NATIVE_PASSWORD: Использует Native Pluggable Authentication. CACHING_SHA2_PASSWORD: Использует Caching SHA-2 Pluggable Authentication. SHA256_PASSWORD: Использует SHA-256 Pluggable Authentication.
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 для перебора страниц результатов.