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

Метод update

Изменяет указанный кластер MySQL.

HTTP-запрос

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

Path-параметры

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

Параметры в теле запроса

{
  "updateMask": "string",
  "description": "string",
  "labels": "object",
  "configSpec": {
    "version": "string",
    "resources": {
      "resourcePresetId": "string",
      "diskSize": "string",
      "diskTypeId": "string"
    },
    "backupWindowStart": {
      "hours": "integer",
      "minutes": "integer",
      "seconds": "integer",
      "nanos": "integer"
    },
    "access": {
      "dataLens": true
    },

    // `configSpec` включает только одно из полей `mysqlConfig_5_7`, `mysqlConfig_8_0`
    "mysqlConfig_5_7": {
      "innodbBufferPoolSize": "integer",
      "maxConnections": "integer",
      "longQueryTime": "number",
      "generalLog": true,
      "auditLog": true,
      "sqlMode": [
        "string"
      ],
      "maxAllowedPacket": "integer",
      "defaultAuthenticationPlugin": "string"
    },
    "mysqlConfig_8_0": {
      "innodbBufferPoolSize": "integer",
      "maxConnections": "integer",
      "longQueryTime": "number",
      "generalLog": true,
      "auditLog": true,
      "sqlMode": [
        "string"
      ],
      "maxAllowedPacket": "integer",
      "defaultAuthenticationPlugin": "string"
    },
    // конец списка возможных полей`configSpec`

  },
  "name": "string"
}
Поле Описание
updateMask string

Маска, которая указывает, какие атрибуты кластера MySQL должны быть изменены.

Имена всех обновляемых полей, разделенные запятыми. Только значения указанных полей будут изменены. Остальные останутся нетронутыми. Если поле указано в параметре updateMask и в запросе не было отправлено значение для этого поля, значение поля будет сброшено на значение по умолчанию. Значение по умолчанию для большинства полей — null или 0.

Если в запросе не передается updateMask, значения всех полей будут обновлены. Для полей, указанных в запросе, будут использованы переданные значения. Значения остальных полей будут сброшены на значения по умолчанию.
description string

Новое описание кластера MySQL.

Максимальная длина строки в символах — 256.
labels object

Пользовательские метки для кластера MySQL в виде пар key:value. Максимум 64 на ресурс. Например, "project": "mvp" или "source": "dictionary".

Новый набор меток полностью заменит старый. Чтобы добавить метку, запросите текущий набор меток с помощью метода get, затем отправьте запрос update, добавив новую метку в этот набор.

Не более 64 на ресурс. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z].
configSpec object

Новая конфигурация и ресурсы для хостов кластера.
configSpec.
version		 string

Версия MySQL, используемая в кластере. Возможные значения:

  • 5.7
  • 8.0
configSpec.
resources		 object
Ресурсы, выделенные хостам MySQL.
configSpec.
resources.
resourcePresetId		 string

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

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

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

  • network-ssd — быстрое сетевое хранилище;
  • local-ssd — быстрое локальное хранилище.
configSpec.
backupWindowStart		 object
Время запуска ежедневного резервного копирования, в часовом поясе UTC.

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

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

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

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

Доли секунды, в наносекундах. Допустимые значения — от 0 до 999 999 999.
configSpec.
access		 object
Политика доступа к БД.
configSpec.
access.
dataLens		 boolean (boolean)

Разрешить доступ для DataLens
configSpec.
mysqlConfig_5_7		 object
Конфигурация для кластера MySQL 5.7.
configSpec включает только одно из полей mysqlConfig_5_7, mysqlConfig_8_0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Плагин аутентификации, используемый в управляемом кластере MySQL.
configSpec.
mysqlConfig_8_0		 object
Конфигурация для кластера MySQL 8.0.
configSpec включает только одно из полей mysqlConfig_5_7, mysqlConfig_8_0

Поля и структура MysqlConfig8_0 отражает параметры конфигурации MySQL 8.0.
configSpec.
mysqlConfig_8_0.
innodbBufferPoolSize		 integer (int64)

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

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

Минимальное значение — 5242880.
configSpec.
mysqlConfig_8_0.
maxConnections		 integer (int64)

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

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

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

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

Подробнее см. в описании переменной в документации MySQL.
configSpec.
mysqlConfig_8_0.
generalLog		 boolean (boolean)

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

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

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

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

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

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

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

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

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

Плагин аутентификации, используемый в управляемом кластере MySQL.
name string

Новое имя кластера.

Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

Ответ

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  включает только одно из полей `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // конец списка возможных полей

}

Ресурс Operation. Дополнительные сведения см. в разделе
Объект Operation.

Поле Описание
id string

Идентификатор операции.
description string

Описание операции. Длина описания должна быть от 0 до 256 символов.
createdAt string (date-time)

Время создания ресурса в формате в RFC3339.

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

Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modifiedAt string (date-time)

Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.

Строка в формате RFC3339.
done boolean (boolean)

Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata object

Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
error object
Описание ошибки в случае сбоя или отмены операции.
включает только одно из полей error, response

Описание ошибки в случае сбоя или отмены операции.
error.
code		 integer (int32)

Код ошибки. Значение из списка google.rpc.Code.
error.
message		 string

Текст ошибки.
error.
details[]		 object

Список сообщений с подробными сведениями об ошибке.
response object
включает только одно из полей error, response

Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.