Метод create

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

HTTP-запрос

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

Path-параметры

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

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

{
  "userSpec": {
    "name": "string",
    "password": "string",
    "permissions": [
      {
        "databaseName": "string"
      }
    ],
    "settings": {
      "readonly": "integer",
      "allowDdl": true,
      "insertQuorum": "integer",
      "insertQuorumTimeout": "integer",
      "selectSequentialConsistency": true,
      "maxReplicaDelayForDistributedQueries": "integer",
      "fallbackToStaleReplicasForDistributedQueries": true,
      "maxThreads": "integer",
      "maxBlockSize": "integer",
      "maxInsertBlockSize": "integer",
      "maxMemoryUsage": "integer",
      "maxMemoryUsageForUser": "integer",
      "maxRowsToRead": "integer",
      "maxBytesToRead": "integer",
      "readOverflowMode": "string",
      "maxRowsToGroupBy": "integer",
      "groupByOverflowMode": "string",
      "maxRowsToSort": "integer",
      "maxBytesToSort": "integer",
      "sortOverflowMode": "string",
      "maxResultRows": "integer",
      "maxResultBytes": "integer",
      "resultOverflowMode": "string",
      "maxRowsInDistinct": "integer",
      "maxBytesInDistinct": "integer",
      "distinctOverflowMode": "string",
      "maxRowsToTransfer": "integer",
      "maxBytesToTransfer": "integer",
      "transferOverflowMode": "string",
      "maxExecutionTime": "integer",
      "timeoutOverflowMode": "string",
      "maxColumnsToRead": "integer",
      "maxTemporaryColumns": "integer",
      "maxTemporaryNonConstColumns": "integer",
      "maxQuerySize": "integer",
      "maxAstDepth": "integer",
      "maxAstElements": "integer",
      "maxExpandedAstElements": "integer"
    }
  }
}
Поле Описание
userSpec object

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

userSpec.
name
string

Обязательное поле. Имя пользователя базы данных ClickHouse.

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

userSpec.
password
string

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

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

userSpec.
permissions[]
object

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

userSpec.
permissions[].
databaseName
string

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

userSpec.
settings
object

Пользовательские настройки ClickHouse. Поддерживаемые параметры входят в число параметров, описанных в разделе ClickHouse documentation.

userSpec.
settings.
readonly
integer (int64)

См. подробное описание в ClickHouse documentation.

Допустимые значения — от 0 до 2 включительно.

userSpec.
settings.
allowDdl
boolean (boolean)

См. подробное описание в ClickHouse documentation.

userSpec.
settings.
insertQuorum
integer (int64)

См. подробное описание в ClickHouse documentation.

Минимальное значение — 0.

userSpec.
settings.
insertQuorumTimeout
integer (int64)

Время ожидания записи для кворума в миллисекундах. Значение по умолчанию: 60000. См. подробное описание в ClickHouse documentation.

Минимальное значение — 1000.

userSpec.
settings.
selectSequentialConsistency
boolean (boolean)

См. подробное описание в ClickHouse documentation.

userSpec.
settings.
maxReplicaDelayForDistributedQueries
integer (int64)

Максимальная задержка реплики в миллисекундах. Если реплика отстает на значение больше установленного, реплика перестает использоваться. Значение по умолчанию: 300000. См. подробное описание в ClickHouse documentation.

Минимальное значение — 1000.

userSpec.
settings.
fallbackToStaleReplicasForDistributedQueries
boolean (boolean)

См. подробное описание в ClickHouse documentation.

userSpec.
settings.
maxThreads
integer (int64)

См. подробное описание в ClickHouse documentation.

Значение должно быть больше 0.

userSpec.
settings.
maxBlockSize
integer (int64)

См. подробное описание в ClickHouse documentation.

Значение должно быть больше 0.

userSpec.
settings.
maxInsertBlockSize
integer (int64)

См. подробное описание в ClickHouse documentation.

Значение должно быть больше 0.

userSpec.
settings.
maxMemoryUsage
integer (int64)

См. подробное описание в ClickHouse documentation.

Минимальное значение — 0.

userSpec.
settings.
maxMemoryUsageForUser
integer (int64)

См. подробное описание в ClickHouse documentation.

Минимальное значение — 0.

userSpec.
settings.
maxRowsToRead
integer (int64)

См. подробное описание в ClickHouse documentation.

Минимальное значение — 0.

userSpec.
settings.
maxBytesToRead
integer (int64)

См. подробное описание в ClickHouse documentation.

Минимальное значение — 0.

userSpec.
settings.
readOverflowMode
string

См. подробное описание в ClickHouse documentation.

userSpec.
settings.
maxRowsToGroupBy
integer (int64)

См. подробное описание в ClickHouse documentation.

Минимальное значение — 0.

userSpec.
settings.
groupByOverflowMode
string

См. подробное описание в ClickHouse documentation.

userSpec.
settings.
maxRowsToSort
integer (int64)

См. подробное описание в ClickHouse documentation.

Минимальное значение — 0.

userSpec.
settings.
maxBytesToSort
integer (int64)

См. подробное описание в ClickHouse documentation.

Минимальное значение — 0.

userSpec.
settings.
sortOverflowMode
string

См. подробное описание в ClickHouse documentation.

userSpec.
settings.
maxResultRows
integer (int64)

См. подробное описание в ClickHouse documentation.

Минимальное значение — 0.

userSpec.
settings.
maxResultBytes
integer (int64)

См. подробное описание в ClickHouse documentation.

Минимальное значение — 0.

userSpec.
settings.
resultOverflowMode
string

См. подробное описание в ClickHouse documentation.

userSpec.
settings.
maxRowsInDistinct
integer (int64)

См. подробное описание в ClickHouse documentation.

Минимальное значение — 0.

userSpec.
settings.
maxBytesInDistinct
integer (int64)

См. подробное описание в ClickHouse documentation.

Минимальное значение — 0.

userSpec.
settings.
distinctOverflowMode
string

См. подробное описание в ClickHouse documentation.

userSpec.
settings.
maxRowsToTransfer
integer (int64)

См. подробное описание в ClickHouse documentation.

Минимальное значение — 0.

userSpec.
settings.
maxBytesToTransfer
integer (int64)

См. подробное описание в ClickHouse documentation.

Минимальное значение — 0.

userSpec.
settings.
transferOverflowMode
string

См. подробное описание в ClickHouse documentation.

userSpec.
settings.
maxExecutionTime
integer (int64)

Максимальное время выполнения запроса в миллисекундах. См. подробное описание в ClickHouse documentation.

Минимальное значение — 0.

userSpec.
settings.
timeoutOverflowMode
string

См. подробное описание в ClickHouse documentation.

userSpec.
settings.
maxColumnsToRead
integer (int64)

Максимальное количество столбцов, которые можно прочитать из таблицы в одном запросе. См. подробное описание в ClickHouse documentation.

Минимальное значение — 0.

userSpec.
settings.
maxTemporaryColumns
integer (int64)

Максимальное количество временных столбцов, которые должны храниться в оперативной памяти одновременно при выполнении запроса, включая постоянные столбцы. См. подробное описание в ClickHouse documentation.

Минимальное значение — 0.

userSpec.
settings.
maxTemporaryNonConstColumns
integer (int64)

Максимальное количество временных столбцов, которые должны храниться в оперативной памяти одновременно при выполнении запроса, за исключением постоянных столбцов. См. подробное описание в ClickHouse documentation.

Минимальное значение — 0.

userSpec.
settings.
maxQuerySize
integer (int64)

Наибольшая часть запроса, которая может быть передана в RAM для разбора с помощью анализатора SQL, в байтах. Значение по умолчанию: 262144. См. подробное описание в ClickHouse documentation.

Значение должно быть больше 0.

userSpec.
settings.
maxAstDepth
integer (int64)

Максимальная глубина синтаксического дерева запроса. Значение по умолчанию: 1000. См. подробное описание в ClickHouse documentation.

Значение должно быть больше 0.

userSpec.
settings.
maxAstElements
integer (int64)

Максимальный размер синтаксического дерева запроса в количестве узлов. Значение по умолчанию: 50000. См. подробное описание в ClickHouse documentation.

Значение должно быть больше 0.

userSpec.
settings.
maxExpandedAstElements
integer (int64)

Максимальный размер синтаксического дерева запроса в количестве узлов после раскрытия псевдонимов и звездочки. Значение по умолчанию: 500000.

Значение должно быть больше 0.

Ответ

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.