Метод create
Создает кластер MySQL в указанном каталоге.
HTTP-запрос
POST https://mdb.api.cloud.yandex.net/managed-mysql/v1alpha/clusters
Параметры в теле запроса
{
"folderId": "string",
"name": "string",
"description": "string",
"labels": "object",
"environment": "string",
"configSpec": {
"version": "string",
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
"backupWindowStart": {
"hours": "integer",
"minutes": "integer",
"seconds": "integer",
"nanos": "integer"
},
"mysqlConfig_5_7": {
"innodbBufferPoolSize": "integer",
"maxConnections": "integer",
"longQueryTime": "number"
}
},
"databaseSpecs": [
{
"name": "string"
}
],
"userSpecs": [
{
"name": "string",
"password": "string",
"permissions": [
{
"databaseName": "string",
"roles": [
"string"
]
}
]
}
],
"hostSpecs": [
{
"zoneId": "string",
"subnetId": "string",
"assignPublicIp": true
}
],
"networkId": "string"
}
Поле | Описание |
---|---|
folderId | string Обязательное поле. Идентификатор каталога, в котором нужно создать кластер MySQL. Максимальная длина строки в символах — 50. |
name | string Обязательное поле. Имя кластера MySQL. Имя должно быть уникальным в каталоге. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению |
description | string Описание кластера MySQL. Максимальная длина строки в символах — 256. |
labels | object Пользовательские метки для кластера MySQL в виде пар Не более 64 на ресурс. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению |
environment | string Среда развертывания кластера MySQL.
|
configSpec | object Конфигурация и ресурсы для хостов, которые должны быть созданы для кластера MySQL. |
configSpec. version |
string Версия MySQL, используемая в кластере. Возможные значения:
|
configSpec. resources |
object Ресурсы, выделенные хостам MySQL. |
configSpec. resources. resourcePresetId |
string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
configSpec. resources. diskSize |
string (int64) Объем хранилища, доступного хосту. |
configSpec. resources. diskTypeId |
string Тип хранилища для хоста. Возможные значения:
|
configSpec. backupWindowStart |
object Время запуска ежедневного резервного копирования, в часовом поясе UTC. Время суток. Дата и часовой пояс либо не учитываются, либо задаются в других местах. API может разрешить использование високосной секунды. Связанные типы: google.type.Date и google.protobuf.Timestamp. |
configSpec. backupWindowStart. hours |
integer (int32) Часы. Допустимые значения: от 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 до 999999999. |
configSpec. mysqlConfig_5_7 |
object Конфигурация для кластера 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. |
databaseSpecs[] | object Описания баз данных, которые нужно создать в кластере MySQL. |
databaseSpecs[]. name |
string Обязательное поле. Имя базы данных MySQL. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению |
userSpecs[] | object Описания пользователей базы данных, которых нужно создать в кластере MySQL. |
userSpecs[]. name |
string Обязательное поле. Имя пользователя MySQL. Максимальная длина строки в символах — 32. Значение должно соответствовать регулярному выражению |
userSpecs[]. password |
string Обязательное поле. Пароль пользователя MySQL. Длина строки в символах должна быть от 8 до 128. |
userSpecs[]. permissions[] |
object Набор разрешений, которые следует предоставить пользователю. |
userSpecs[]. permissions[]. databaseName |
string Имя базы данных, к которой предоставляет доступ разрешение. |
userSpecs[]. permissions[]. roles[] |
string
Некоторые операторы SELECT могут быть разрешены без привилегии SELECT. Привилегия SELECT необходима для всех операторов, считывающих значения столбцов. Подробнее в документации MySQL.
|
hostSpecs[] | object Конфигурации для отдельных хостов, которые должны быть созданы для кластера MySQL. |
hostSpecs[]. zoneId |
string Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос list. Максимальная длина строки в символах — 50. |
hostSpecs[]. subnetId |
string Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети задан в поле Cluster.networkId. Максимальная длина строки в символах — 50. |
hostSpecs[]. assignPublicIp |
boolean (boolean) Должен ли хост получить публичный IP-адрес при создании. После создания узла этот параметр изменить нельзя. Чтобы удалить назначенный публичный IP-адрес или назначить публичный IP уже созданному хосту, пересоздайте хост с нужным значением поля Возможные значения:
|
networkId | string Идентификатор сети, в которой нужно создать кластер. Максимальная длина строки в символах — 50. |
Ответ
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) Если значение равно |
metadata | object Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля |
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, в описании метода приведена структура соответствующего ему поля |