Метод create

Создает пользователя MySQL в указанном кластере.

HTTP-запрос

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

Path-параметры

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

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

{
  "userSpec": {
    "name": "string",
    "password": "string",
    "permissions": [
      {
        "databaseName": "string",
        "roles": [
          "string"
        ]
      }
    ]
  }
}
Поле Описание
userSpec object

Обязательное поле. Свойства создаваемого пользователя.

userSpec.
name
string

Обязательное поле. Имя пользователя MySQL.

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

userSpec.
password
string

Обязательное поле. Пароль пользователя MySQL.

Длина строки в символах должна быть от 8 до 128.

userSpec.
permissions[]
object

Набор разрешений, которые следует предоставить пользователю.

userSpec.
permissions[].
databaseName
string

Имя базы данных, к которой предоставляет доступ разрешение.

userSpec.
permissions[].
roles[]
string
  • ALL_PRIVILEGES: Все привилегии, которые могут быть предоставлены пользователю.
  • ALTER: Изменение таблиц.
  • ALTER_ROUTINE: Изменение хранимых процедур и функций.
  • CREATE: Создание таблиц или индексов.
  • CREATE_ROUTINE: Создание хранимых процедур.
  • CREATE_TEMPORARY_TABLES: Создание временных таблиц.
  • CREATE_VIEW: Создание представлений.
  • DELETE: Удаление таблиц.
  • DROP: Удаление таблиц или представлений.
  • EVENT: Создание, изменение, удаление или отображение событий для планировщика событий.
  • EXECUTE: Выполнение хранимых процедур.
  • INDEX: Создание и удаление индексов.
  • INSERT: Вставка строк в базу данных.
  • LOCK_TABLES: Использование инструкции LOCK TABLES для таблиц, доступных с привилегией SELECT.
  • SELECT: Получение строк из таблиц.

Некоторые операторы SELECT могут быть разрешены без привилегии SELECT. Привилегия SELECT необходима для всех операторов, считывающих значения столбцов. Подробнее в MySQL documentation.

  • SHOW_VIEW: Использование инструкции SHOW CREATE VIEW. Также необходимо для представлений, используемых с EXPLAIN.
  • TRIGGER: Создание, удаление, выполнение или отображение триггеров для таблицы.
  • UPDATE: Обновление строк в базе данных.

Ответ

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.