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

Метод 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",
      "connectTimeout": "integer",
      "receiveTimeout": "integer",
      "sendTimeout": "integer",
      "insertQuorumTimeout": "integer",
      "selectSequentialConsistency": true,
      "maxReplicaDelayForDistributedQueries": "integer",
      "fallbackToStaleReplicasForDistributedQueries": true,
      "replicationAlterPartitionsSync": "integer",
      "distributedProductMode": "string",
      "distributedAggregationMemoryEfficient": true,
      "distributedDdlTaskTimeout": "integer",
      "compile": true,
      "minCountToCompile": "integer",
      "compileExpressions": true,
      "minCountToCompileExpression": "integer",
      "maxBlockSize": "integer",
      "minInsertBlockSizeRows": "integer",
      "minInsertBlockSizeBytes": "integer",
      "maxInsertBlockSize": "integer",
      "minBytesToUseDirectIo": "integer",
      "useUncompressedCache": true,
      "mergeTreeMaxRowsToUseCache": "integer",
      "mergeTreeMaxBytesToUseCache": "integer",
      "mergeTreeMinRowsForConcurrentRead": "integer",
      "mergeTreeMinBytesForConcurrentRead": "integer",
      "maxBytesBeforeExternalGroupBy": "integer",
      "maxBytesBeforeExternalSort": "integer",
      "groupByTwoLevelThreshold": "integer",
      "groupByTwoLevelThresholdBytes": "integer",
      "priority": "integer",
      "maxThreads": "integer",
      "maxMemoryUsage": "integer",
      "maxMemoryUsageForUser": "integer",
      "maxNetworkBandwidth": "integer",
      "maxNetworkBandwidthForUser": "integer",
      "forceIndexByDate": true,
      "forcePrimaryKey": true,
      "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",
      "inputFormatValuesInterpretExpressions": true,
      "inputFormatDefaultsForOmittedFields": true,
      "outputFormatJsonQuote_64BitIntegers": true,
      "outputFormatJsonQuoteDenormals": true,
      "lowCardinalityAllowInNativeFormat": true,
      "emptyResultForAggregationByEmptySet": true,
      "httpConnectionTimeout": "integer",
      "httpReceiveTimeout": "integer",
      "httpSendTimeout": "integer",
      "enableHttpCompression": true,
      "sendProgressInHttpHeaders": true,
      "httpHeadersProgressInterval": "integer",
      "addHttpCorsHeader": true
    },
    "quotas": [
      {
        "intervalDuration": "integer",
        "queries": "integer",
        "errors": "integer",
        "resultRows": "integer",
        "readRows": "integer",
        "executionTime": "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.
userSpec.
settings.
readonly		 integer (int64)

Ограничивает разрешения для запросов, не относящихся к DDL. Возможные значения:

  • 0 (по умолчанию) - никаких ограничений.
  • 1-разрешены только запросы на чтение данных.
  • 2 — разрешены запросы на чтение данных и изменение настроек. См. подробное описание в документации ClickHouse.

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

Разрешены ли запросы DDL. Значение по умолчанию "false". См. подробное описание в документации ClickHouse.
userSpec.
settings.
insertQuorum		 integer (int64)

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

Минимальное значение — 0.
userSpec.
settings.
connectTimeout		 integer (int64)

Время ожидания соединения в миллисекундах. См. подробное описание в документации ClickHouse.

Значение должно быть больше 0.
userSpec.
settings.
receiveTimeout		 integer (int64)

Время ожидания приема в миллисекундах. См. подробное описание в документации ClickHouse.

Значение должно быть больше 0.
userSpec.
settings.
sendTimeout		 integer (int64)

Время ожидания отправки в миллисекундах. См. подробное описание в документации ClickHouse.

Значение должно быть больше 0.
userSpec.
settings.
insertQuorumTimeout		 integer (int64)

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

Минимальное значение — 1000.
userSpec.
settings.
selectSequentialConsistency		 boolean (boolean)

См. подробное описание в документации ClickHouse.
userSpec.
settings.
maxReplicaDelayForDistributedQueries		 integer (int64)

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

Минимальное значение — 1000.
userSpec.
settings.
fallbackToStaleReplicasForDistributedQueries		 boolean (boolean)

См. подробное описание в документации ClickHouse.
userSpec.
settings.
replicationAlterPartitionsSync		 integer (int64)

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

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

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

  • DISTRIBUTED_PRODUCT_MODE_DENY: Значение по умолчанию. Запрещает использование этих типов подзапросов (возвращает исключение "Double-distributed in/JOIN subqueries is denied").
  • DISTRIBUTED_PRODUCT_MODE_LOCAL: Заменяет базу данных и таблицу в подзапросе локальными для конечного сервера (шарда), оставляя обычный IN / JOIN.
  • DISTRIBUTED_PRODUCT_MODE_GLOBAL: Заменяет IN/JOIN запрос на GLOBAL IN/GLOBAL JOIN.
  • DISTRIBUTED_PRODUCT_MODE_ALLOW: Позволяет использовать эти типы подзапросов.
userSpec.
settings.
distributedAggregationMemoryEfficient		 boolean (boolean)

Включен ли режим экономии памяти распределенной агрегации.
userSpec.
settings.
distributedDdlTaskTimeout		 integer (int64)

Время ожидания запросов DDL в миллисекундах.
userSpec.
settings.
compile		 boolean (boolean)

Включена ли компиляция запросов. См. подробное описание в документации ClickHouse.
userSpec.
settings.
minCountToCompile		 integer (int64)

Число структурно идентичных запросов до их компиляции. См. подробное описание в документации ClickHouse.

Минимальное значение — 0.
userSpec.
settings.
compileExpressions		 boolean (boolean)

Включена ли компиляция выражений.
userSpec.
settings.
minCountToCompileExpression		 integer (int64)

Число идентичных выражений до их компиляции.

Минимальное значение — 0.
userSpec.
settings.
maxBlockSize		 integer (int64)

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

Значение должно быть больше 0.
userSpec.
settings.
minInsertBlockSizeRows		 integer (int64)

Минимальный размер блока в строках при выполнении INSERT запросов. Блоки меньшего размера ClickHouse будет склеивать в один блок. Если установлено значение "0", ClichHouse не будет склеивать блоки.

Минимальное значение — 0.
userSpec.
settings.
minInsertBlockSizeBytes		 integer (int64)

Минимальный размер блока в байтах при выполнении INSERT запросов. Блоки меньшего размера ClickHouse будет склеивать в один блок. Если установлено значение "0", ClichHouse не будет склеивать блоки.

Минимальное значение — 0.
userSpec.
settings.
maxInsertBlockSize		 integer (int64)

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

Значение должно быть больше 0.
userSpec.
settings.
minBytesToUseDirectIo		 integer (int64)

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

Минимальное значение — 0.
userSpec.
settings.
useUncompressedCache		 boolean (boolean)

См. подробное описание в документации ClickHouse.
userSpec.
settings.
mergeTreeMaxRowsToUseCache		 integer (int64)

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

Значение должно быть больше 0.
userSpec.
settings.
mergeTreeMaxBytesToUseCache		 integer (int64)

Максимальный размер запроса в байтах для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанное значение.

Значение должно быть больше 0.
userSpec.
settings.
mergeTreeMinRowsForConcurrentRead		 integer (int64)

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

Значение должно быть больше 0.
userSpec.
settings.
mergeTreeMinBytesForConcurrentRead		 integer (int64)

Минимальное число байтов, считываемых из файла для одновременного чтения.

Значение должно быть больше 0.
userSpec.
settings.
maxBytesBeforeExternalGroupBy		 integer (int64)
userSpec.
settings.
maxBytesBeforeExternalSort		 integer (int64)
userSpec.
settings.
groupByTwoLevelThreshold		 integer (int64)
userSpec.
settings.
groupByTwoLevelThresholdBytes		 integer (int64)
userSpec.
settings.
priority		 integer (int64)

Приоритет запроса.

Минимальное значение — 0.
userSpec.
settings.
maxThreads		 integer (int64)

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

Значение должно быть больше 0.
userSpec.
settings.
maxMemoryUsage		 integer (int64)

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

Минимальное значение — 0.
userSpec.
settings.
maxMemoryUsageForUser		 integer (int64)

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

Минимальное значение — 0.
userSpec.
settings.
maxNetworkBandwidth		 integer (int64)

См. подробное описание в документации ClickHouse.
userSpec.
settings.
maxNetworkBandwidthForUser		 integer (int64)

См. подробное описание в документации ClickHouse.
userSpec.
settings.
forceIndexByDate		 boolean (boolean)

См. подробное описание в документации ClickHouse.
userSpec.
settings.
forcePrimaryKey		 boolean (boolean)

См. подробное описание в документации ClickHouse.
userSpec.
settings.
maxRowsToRead		 integer (int64)

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

Минимальное значение — 0.
userSpec.
settings.
maxBytesToRead		 integer (int64)

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

Минимальное значение — 0.
userSpec.
settings.
readOverflowMode		 string

См. подробное описание в документации ClickHouse.
userSpec.
settings.
maxRowsToGroupBy		 integer (int64)

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

Минимальное значение — 0.
userSpec.
settings.
groupByOverflowMode		 string

См. подробное описание в документации ClickHouse.
userSpec.
settings.
maxRowsToSort		 integer (int64)

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

Минимальное значение — 0.
userSpec.
settings.
maxBytesToSort		 integer (int64)

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

Минимальное значение — 0.
userSpec.
settings.
sortOverflowMode		 string

См. подробное описание в документации ClickHouse.
userSpec.
settings.
maxResultRows		 integer (int64)

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

Минимальное значение — 0.
userSpec.
settings.
maxResultBytes		 integer (int64)

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

Минимальное значение — 0.
userSpec.
settings.
resultOverflowMode		 string

См. подробное описание в документации ClickHouse.
userSpec.
settings.
maxRowsInDistinct		 integer (int64)

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

Минимальное значение — 0.
userSpec.
settings.
maxBytesInDistinct		 integer (int64)

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

Минимальное значение — 0.
userSpec.
settings.
distinctOverflowMode		 string

См. подробное описание в документации ClickHouse.
userSpec.
settings.
maxRowsToTransfer		 integer (int64)

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

Минимальное значение — 0.
userSpec.
settings.
maxBytesToTransfer		 integer (int64)

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

Минимальное значение — 0.
userSpec.
settings.
transferOverflowMode		 string

См. подробное описание в документации ClickHouse.
userSpec.
settings.
maxExecutionTime		 integer (int64)

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

Минимальное значение — 0.
userSpec.
settings.
timeoutOverflowMode		 string

См. подробное описание в документации ClickHouse.
userSpec.
settings.
maxColumnsToRead		 integer (int64)

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

Минимальное значение — 0.
userSpec.
settings.
maxTemporaryColumns		 integer (int64)

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

Минимальное значение — 0.
userSpec.
settings.
maxTemporaryNonConstColumns		 integer (int64)

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

Минимальное значение — 0.
userSpec.
settings.
maxQuerySize		 integer (int64)

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

Значение должно быть больше 0.
userSpec.
settings.
maxAstDepth		 integer (int64)

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

Значение должно быть больше 0.
userSpec.
settings.
maxAstElements		 integer (int64)

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

Значение должно быть больше 0.
userSpec.
settings.
maxExpandedAstElements		 integer (int64)

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

Значение должно быть больше 0.
userSpec.
settings.
inputFormatValuesInterpretExpressions		 boolean (boolean)

См. подробное описание в документации ClickHouse.
userSpec.
settings.
inputFormatDefaultsForOmittedFields		 boolean (boolean)

См. подробное описание в документации ClickHouse.
userSpec.
settings.
outputFormatJsonQuote_64BitIntegers		 boolean (boolean)

Если значение истинно, то при использовании JSON форматов UInt64 и Int64 числа выводятся в кавычках. См. подробное описание в документации ClickHouse.
userSpec.
settings.
outputFormatJsonQuoteDenormals		 boolean (boolean)

Включен ли вывод специальных значений с плавающей запятой ( "+nan", "-nan", "+inf" и "-inf") в формате вывода JSON.
userSpec.
settings.
lowCardinalityAllowInNativeFormat		 boolean (boolean)
userSpec.
settings.
emptyResultForAggregationByEmptySet		 boolean (boolean)
userSpec.
settings.
httpConnectionTimeout		 integer (int64)

Время ожидания соединения в миллисекундах.
userSpec.
settings.
httpReceiveTimeout		 integer (int64)

Время ожидания приема в миллисекундах.
userSpec.
settings.
httpSendTimeout		 integer (int64)

Время ожидания отправки в миллисекундах.
userSpec.
settings.
enableHttpCompression		 boolean (boolean)

См. подробное описание в документации ClickHouse.
userSpec.
settings.
sendProgressInHttpHeaders		 boolean (boolean)

Включены ли уведомления о ходе выполнения с использованием заголовков X-ClickHouse-Progress. Значение по умолчанию "false". См. подробное описание в документации ClickHouse.
userSpec.
settings.
httpHeadersProgressInterval		 integer (int64)

Минимальный интервал между уведомлениями о ходе выполнения, в миллисекундах. Значение по умолчанию: 100.
userSpec.
settings.
addHttpCorsHeader		 boolean (boolean)

Включен ли заголовок CORS в HTTP-ответах. Значение по умолчанию "false".
userSpec.
quotas[]		 object

Представление квот ClickHouse. Каждая квота связана с пользователем и ограничивает использование ресурсов на определенный интервал. См. подробное описание в документации ClickHouse.
userSpec.
quotas[].
intervalDuration		 integer (int64)

Длительность интервала для квоты в миллисекундах. Минимальное значение - 1 минута.

Минимальное значение — 60000.
userSpec.
quotas[].
queries		 integer (int64)

Общее количество запросов. 0-неограниченно.

Минимальное значение — 0.
userSpec.
quotas[].
errors		 integer (int64)

Количество запросов, которые вызвали исключение. 0-неограниченно.

Минимальное значение — 0.
userSpec.
quotas[].
resultRows		 integer (int64)

Общее число строк, приведенных в результате. 0-неограниченно.

Минимальное значение — 0.
userSpec.
quotas[].
readRows		 integer (int64)

Общее число исходных строк, считанных из таблиц для выполнения запроса, на всех удаленных серверах. 0-неограниченно.

Минимальное значение — 0.
userSpec.
quotas[].
executionTime		 integer (int64)

Общее время выполнения запроса, в миллисекундах. 0-неограниченно.

Минимальное значение — 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.