Метод create

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

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

HTTP-запрос

POST https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters

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

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "environment": "string",
  "configSpec": {
    "version": "string",
    "clickhouse": {
      "config": {
        "logLevel": "string",
        "mergeTree": {
          "replicatedDeduplicationWindow": "integer",
          "replicatedDeduplicationWindowSeconds": "integer",
          "partsToDelayInsert": "integer",
          "partsToThrowInsert": "integer",
          "maxReplicatedMergesInQueue": "integer",
          "numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "integer",
          "maxBytesToMergeAtMinSpaceInPool": "integer"
        },
        "compression": [
          {
            "method": "string",
            "minPartSize": "string",
            "minPartSizeRatio": "number"
          }
        ],
        "dictionaries": [
          {
            "name": "string",
            "structure": {
              "id": {
                "name": "string"
              },
              "key": {
                "attributes": [
                  {
                    "name": "string",
                    "type": "string",
                    "nullValue": "string",
                    "expression": "string",
                    "hierarchical": true,
                    "injective": true
                  }
                ]
              },
              "rangeMin": {
                "name": "string",
                "type": "string",
                "nullValue": "string",
                "expression": "string",
                "hierarchical": true,
                "injective": true
              },
              "rangeMax": {
                "name": "string",
                "type": "string",
                "nullValue": "string",
                "expression": "string",
                "hierarchical": true,
                "injective": true
              },
              "attributes": [
                {
                  "name": "string",
                  "type": "string",
                  "nullValue": "string",
                  "expression": "string",
                  "hierarchical": true,
                  "injective": true
                }
              ]
            },
            "layout": {
              "type": "string",
              "sizeInCells": "string"
            },

            // `configSpec.clickhouse.config.dictionaries[]` включает только одно из полей `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
            "fixedLifetime": "string",
            "lifetimeRange": {
              "min": "string",
              "max": "string"
            },
            // конец списка возможных полей`configSpec.clickhouse.config.dictionaries[]`

            "httpSource": {
              "url": "string",
              "format": "string"
            },
            "mysqlSource": {
              "db": "string",
              "table": "string",
              "port": "string",
              "user": "string",
              "password": "string",
              "replicas": [
                {
                  "host": "string",
                  "priority": "string",
                  "port": "string",
                  "user": "string",
                  "password": "string"
                }
              ],
              "where": "string",
              "invalidateQuery": "string"
            },
            "clickhouseSource": {
              "db": "string",
              "table": "string",
              "host": "string",
              "port": "string",
              "user": "string",
              "password": "string",
              "where": "string"
            },
            "mongodbSource": {
              "db": "string",
              "collection": "string",
              "host": "string",
              "port": "string",
              "user": "string",
              "password": "string"
            },
            "postgresqlSource": {
              "db": "string",
              "table": "string",
              "hosts": [
                "string"
              ],
              "port": "string",
              "user": "string",
              "password": "string",
              "invalidateQuery": "string",
              "sslMode": "string"
            }
          }
        ],
        "graphiteRollup": [
          {
            "name": "string",
            "patterns": [
              {
                "regexp": "string",
                "function": "string",
                "retention": [
                  {
                    "age": "string",
                    "precision": "string"
                  }
                ]
              }
            ]
          }
        ],
        "maxConnections": "integer",
        "maxConcurrentQueries": "integer",
        "keepAliveTimeout": "integer",
        "uncompressedCacheSize": "integer",
        "markCacheSize": "integer",
        "maxTableSizeToDrop": "integer",
        "maxPartitionSizeToDrop": "integer",
        "builtinDictionariesReloadInterval": "integer",
        "timezone": "string",
        "geobaseUri": "string"
      },
      "resources": {
        "resourcePresetId": "string",
        "diskSize": "string",
        "diskTypeId": "string"
      }
    },
    "zookeeper": {
      "resources": {
        "resourcePresetId": "string",
        "diskSize": "string",
        "diskTypeId": "string"
      }
    },
    "backupWindowStart": {
      "hours": "integer",
      "minutes": "integer",
      "seconds": "integer",
      "nanos": "integer"
    },
    "access": {
      "dataLens": true,
      "webSql": true,
      "metrika": true,
      "serverless": true
    }
  },
  "databaseSpecs": [
    {
      "name": "string"
    }
  ],
  "userSpecs": [
    {
      "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",
        "skipUnavailableShards": true,
        "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"
        }
      ]
    }
  ],
  "hostSpecs": [
    {
      "zoneId": "string",
      "type": "string",
      "subnetId": "string",
      "assignPublicIp": true,
      "shardName": "string"
    }
  ],
  "networkId": "string",
  "shardName": "string",
  "serviceAccountId": "string"
}

Поле	Описание
folderId	string Обязательное поле. Идентификатор каталога, в котором нужно создать кластер ClickHouse. Максимальная длина строки в символах — 50.
name	string Обязательное поле. Имя кластера ClickHouse. Имя должно быть уникальным в рамках каталога. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению `[a-zA-Z0-9_-]*`.
description	string Описание кластера ClickHouse. Максимальная длина строки в символах — 256.
labels	object Пользовательские метки для кластера ClickHouse в виде пар `key:value`. Максимум 64 на ресурс. Например, "project": "mvp" или "source": "dictionary". Не более 64 на ресурс. Максимальная длина строки в символах для каждого ключа — 63. Каждый ключ должен соответствовать регулярному выражению `[a-z][-_0-9a-z]`. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению `[-_0-9a-z]`.
environment	string Обязательное поле. Среда развертывания кластера ClickHouse. Среда развертывания. PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления. PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
configSpec	object Обязательное поле. Конфигурация и ресурсы для хостов, которые должны быть созданы для кластера ClickHouse.
configSpec. version	string Версия серверного программного обеспечения ClickHouse.
configSpec. clickhouse	object Конфигурация и ресурсы для сервера ClickHouse.
configSpec. clickhouse. config	object Конфигурация для сервера ClickHouse. Настройки конфигурации ClickHouse. Подробное описание для каждого набора настроек доступно в документации ClickHouse. Любые настройки, не перечисленные здесь, не поддерживаются.
configSpec. clickhouse. config. logLevel	string Уровень логирования для кластера ClickHouse. Допустимые значения: "TRACE", "DEBUG", "INFORMATION", "WARNING", "ERROR". См. описание в документации ClickHouse.
configSpec. clickhouse. config. mergeTree	object Параметры движка MergeTree. См. описание в документации ClickHouse. Настройки движка таблицы MergeTree.
configSpec. clickhouse. config. mergeTree. replicatedDeduplicationWindow	integer (int64) Количество блоков хэшей, которые должен хранить ZooKeeper. Смотрите подробное описание в ClickHouse sources.
configSpec. clickhouse. config. mergeTree. replicatedDeduplicationWindowSeconds	integer (int64) Период времени, в течение которого следует хранить блоки хэшей. См. описание в ClickHouse sources.
configSpec. clickhouse. config. mergeTree. partsToDelayInsert	integer (int64)
configSpec. clickhouse. config. mergeTree. partsToThrowInsert	integer (int64)
configSpec. clickhouse. config. mergeTree. maxReplicatedMergesInQueue	integer (int64)
configSpec. clickhouse. config. mergeTree. numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge	integer (int64)
configSpec. clickhouse. config. mergeTree. maxBytesToMergeAtMinSpaceInPool	integer (int64)
configSpec. clickhouse. config. compression[]	object Параметры сжатия для кластера ClickHouse. См. подробное описание в документации ClickHouse.
configSpec. clickhouse. config. compression[]. method	string Метод сжатия, используемый для указанной комбинации "min_part_size" и "min_part_size_ratio". LZ4: LZ4 compression algorithm. ZSTD: Zstandard compression algorithm.
configSpec. clickhouse. config. compression[]. minPartSize	string (int64) Минимальный размер части таблицы. Минимальное значение — 1.
configSpec. clickhouse. config. compression[]. minPartSizeRatio	number (double) Минимальное отношение части к размеру всех данных в таблице.
configSpec. clickhouse. config. dictionaries[]	object Конфигурация внешних словарей для кластера ClickHouse. См. подробное описание в документации ClickHouse.
configSpec. clickhouse. config. dictionaries[]. name	string Обязательное поле. Имя внешнего словаря.
configSpec. clickhouse. config. dictionaries[]. structure	object Обязательное поле. Набор атрибутов внешнего словаря. Подробное описание см. в документации ClickHouse.
configSpec. clickhouse. config. dictionaries[]. structure. id	object Один столбец с числовыми ключами для словаря. Числовой ключ.
configSpec. clickhouse. config. dictionaries[]. structure. id. name	string Обязательное поле. Имя числового ключа.
configSpec. clickhouse. config. dictionaries[]. structure. key	object Составной ключ для словаря, содержащего один или несколько столбцов с ключами. Подробнее см. в документации ClickHouse. Составной ключ.
configSpec. clickhouse. config. dictionaries[]. structure. key. attributes[]	object Обязательное поле. Поля составного ключа. Должен содержать хотя бы один элемент.
configSpec. clickhouse. config. dictionaries[]. structure. key. attributes[]. name	string Обязательное поле. Имя столбца.
configSpec. clickhouse. config. dictionaries[]. structure. key. attributes[]. type	string Обязательное поле. Тип столбца.
configSpec. clickhouse. config. dictionaries[]. structure. key. attributes[]. nullValue	string Значение по умолчанию для элемента без данных (например, пустая строка).
configSpec. clickhouse. config. dictionaries[]. structure. key. attributes[]. expression	string Выражение, описывающее атрибут, если применимо.
configSpec. clickhouse. config. dictionaries[]. structure. key. attributes[]. hierarchical	boolean (boolean) Признак поддержки иерархии. Значение по умолчанию "false".
configSpec. clickhouse. config. dictionaries[]. structure. key. attributes[]. injective	boolean (boolean) Признакт инъективного отображения "id -> атрибут". Значение по умолчанию "false".
configSpec. clickhouse. config. dictionaries[]. structure. rangeMin	object Поле, содержащее начало диапазона для словарей, которые хранятся в памяти способом "RANGE_HASHED". Подробнее см.документации ClickHouse
configSpec. clickhouse. config. dictionaries[]. structure. rangeMin. name	string Обязательное поле. Имя столбца.
configSpec. clickhouse. config. dictionaries[]. structure. rangeMin. type	string Обязательное поле. Тип столбца.
configSpec. clickhouse. config. dictionaries[]. structure. rangeMin. nullValue	string Значение по умолчанию для элемента без данных (например, пустая строка).
configSpec. clickhouse. config. dictionaries[]. structure. rangeMin. expression	string Выражение, описывающее атрибут, если применимо.
configSpec. clickhouse. config. dictionaries[]. structure. rangeMin. hierarchical	boolean (boolean) Признак поддержки иерархии. Значение по умолчанию "false".
configSpec. clickhouse. config. dictionaries[]. structure. rangeMin. injective	boolean (boolean) Признакт инъективного отображения "id -> атрибут". Значение по умолчанию "false".
configSpec. clickhouse. config. dictionaries[]. structure. rangeMax	object Поле, содержащее конец диапазона для словарей, которые хранятся в памяти способом "RANGE_HASHED". Подробнее см.документации ClickHouse
configSpec. clickhouse. config. dictionaries[]. structure. rangeMax. name	string Обязательное поле. Имя столбца.
configSpec. clickhouse. config. dictionaries[]. structure. rangeMax. type	string Обязательное поле. Тип столбца.
configSpec. clickhouse. config. dictionaries[]. structure. rangeMax. nullValue	string Значение по умолчанию для элемента без данных (например, пустая строка).
configSpec. clickhouse. config. dictionaries[]. structure. rangeMax. expression	string Выражение, описывающее атрибут, если применимо.
configSpec. clickhouse. config. dictionaries[]. structure. rangeMax. hierarchical	boolean (boolean) Признак поддержки иерархии. Значение по умолчанию "false".
configSpec. clickhouse. config. dictionaries[]. structure. rangeMax. injective	boolean (boolean) Признакт инъективного отображения "id -> атрибут". Значение по умолчанию "false".
configSpec. clickhouse. config. dictionaries[]. structure. attributes[]	object Обязательное поле. Описание полей, доступных для запросов к базе данных. Подробнее см. в документации ClickHouse. Должен содержать хотя бы один элемент.
configSpec. clickhouse. config. dictionaries[]. structure. attributes[]. name	string Обязательное поле. Имя столбца.
configSpec. clickhouse. config. dictionaries[]. structure. attributes[]. type	string Обязательное поле. Тип столбца.
configSpec. clickhouse. config. dictionaries[]. structure. attributes[]. nullValue	string Значение по умолчанию для элемента без данных (например, пустая строка).
configSpec. clickhouse. config. dictionaries[]. structure. attributes[]. expression	string Выражение, описывающее атрибут, если применимо.
configSpec. clickhouse. config. dictionaries[]. structure. attributes[]. hierarchical	boolean (boolean) Признак поддержки иерархии. Значение по умолчанию "false".
configSpec. clickhouse. config. dictionaries[]. structure. attributes[]. injective	boolean (boolean) Признакт инъективного отображения "id -> атрибут". Значение по умолчанию "false".
configSpec. clickhouse. config. dictionaries[]. layout	object Обязательное поле. Макет для хранения словаря в памяти. Подробное описание см. в документации ClickHouse. Макет, определяющий способ хранения словаря в памяти.
configSpec. clickhouse. config. dictionaries[]. layout. type	string Обязательное поле. Тип макета для внешнего словаря. FLAT: Весь словарь хранится в памяти в виде плоских массивов. Доступно для любых источников словарей. HASHED: Весь словарь хранится в памяти в виде хэш-таблицы. Доступно для любых источников словарей. COMPLEX_KEY_HASHED: Аналогичен HASHED, для использования с составными ключами. Доступно для любых источников словарей. RANGE_HASHED: Весь словарь хранится в памяти в виде хэш-таблицы, с упорядоченным массивом диапазонов и соответствующих им значений. Доступно для любых источников словарей. CACHE: Словарь хранится в кэше с заданным количеством ячеек. Доступно для источников словарей MySQL, ClickHouse и HTTP. COMPLEX_KEY_CACHE: Аналогичен CACHE, для использования с составными ключами. Доступно для источников словарей MySQL, ClickHouse и HTTP.
configSpec. clickhouse. config. dictionaries[]. layout. sizeInCells	string (int64) Количество ячеек в кэше. Округляется до степени двойки. Применимо только для типов макета CACHE и COMPLEX_KEY_CACHE.
configSpec. clickhouse. config. dictionaries[]. fixedLifetime	string (int64) `configSpec.clickhouse.config.dictionaries[]` включает только одно из полей `fixedLifetime`, `lifetimeRange` Жесткий интервал между обновлениями словаря.
configSpec. clickhouse. config. dictionaries[]. lifetimeRange	object Диапазон интервалов между обновлениями словаря, из которых может выбирать ClickHouse. `configSpec.clickhouse.config.dictionaries[]` включает только одно из полей `fixedLifetime`, `lifetimeRange`
configSpec. clickhouse. config. dictionaries[]. lifetimeRange. min	string (int64) Минимальное время жизни словаря.
configSpec. clickhouse. config. dictionaries[]. lifetimeRange. max	string (int64) Максимальное время жизни словаря.
configSpec. clickhouse. config. dictionaries[]. httpSource	object HTTP-источник для словаря. `configSpec.clickhouse.config.dictionaries[]` включает только одно из полей `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
configSpec. clickhouse. config. dictionaries[]. httpSource. url	string Обязательное поле. URL внешнего словаря, доступного по HTTP.
configSpec. clickhouse. config. dictionaries[]. httpSource. format	string Обязательное поле. Формат данных. Допустимые значения: все форматы, поддерживаемые диалектом ClickHouse SQL.
configSpec. clickhouse. config. dictionaries[]. mysqlSource	object MySQL-источник для словаря. `configSpec.clickhouse.config.dictionaries[]` включает только одно из полей `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
configSpec. clickhouse. config. dictionaries[]. mysqlSource. db	string Обязательное поле. Имя базы данных MySQL, к которой нужно подключаться.
configSpec. clickhouse. config. dictionaries[]. mysqlSource. table	string Обязательное поле. Имя таблицы базы данных, которую следует использовать в качестве словаря ClickHouse.
configSpec. clickhouse. config. dictionaries[]. mysqlSource. port	string (int64) Порт по умолчанию, который нужно использовать при подключении к реплике источника словаря. Допустимые значения — от 0 до 65535 включительно.
configSpec. clickhouse. config. dictionaries[]. mysqlSource. user	string Имя пользователя по умолчанию для реплик источника словаря.
configSpec. clickhouse. config. dictionaries[]. mysqlSource. password	string Пароль пользователя по умолчанию для реплик источника словаря.
configSpec. clickhouse. config. dictionaries[]. mysqlSource. replicas[]	object Обязательное поле. Список реплик базы данных MySQL, используемой в качестве источника словаря. Должен содержать хотя бы один элемент.
configSpec. clickhouse. config. dictionaries[]. mysqlSource. replicas[]. host	string Обязательное поле. Хост реплики MySQL. Максимальная длина строки в символах — 253.
configSpec. clickhouse. config. dictionaries[]. mysqlSource. replicas[]. priority	string (int64) Обязательное поле. Приоритет реплики, который ClickHouse должен учитывать при подключении. Реплике с наивысшим приоритетом должно соответствовать наименьшее значение в этом поле. Значение должно быть больше 0.
configSpec. clickhouse. config. dictionaries[]. mysqlSource. replicas[]. port	string (int64) Порт, который нужно использовать при подключении к реплике. Если для какой-либо реплики не указан порт, ClickHouse использует порт, указанный для источника. Допустимые значения — от 0 до 65535 включительно.
configSpec. clickhouse. config. dictionaries[]. mysqlSource. replicas[]. user	string Имя пользователя базы данных MySQL.
configSpec. clickhouse. config. dictionaries[]. mysqlSource. replicas[]. password	string Пароль пользователя базы данных MySQL.
configSpec. clickhouse. config. dictionaries[]. mysqlSource. where	string Критерии выбора данных в указанной таблице MySQL.
configSpec. clickhouse. config. dictionaries[]. mysqlSource. invalidateQuery	string Запрос на проверку состояния словаря, который позволит извлекать только обновленные данные. Дополнительные сведения см. в документации ClickHouse on dictionaries.
configSpec. clickhouse. config. dictionaries[]. clickhouseSource	object ClickHouse-источник для словаря. `configSpec.clickhouse.config.dictionaries[]` включает только одно из полей `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
configSpec. clickhouse. config. dictionaries[]. clickhouseSource. db	string Обязательное поле. Имя базы данных ClickHouse.
configSpec. clickhouse. config. dictionaries[]. clickhouseSource. table	string Обязательное поле. Имя таблицы в указанной базе данных, используемой в качестве источника словаря.
configSpec. clickhouse. config. dictionaries[]. clickhouseSource. host	string Обязательное поле. Хост ClickHouse для указанной базы данных. Максимальная длина строки в символах — 253.
configSpec. clickhouse. config. dictionaries[]. clickhouseSource. port	string (int64) Порт для подключения к хосту. Допустимые значения — от 0 до 65535 включительно.
configSpec. clickhouse. config. dictionaries[]. clickhouseSource. user	string Обязательное поле. Имя пользователя базы данных ClickHouse.
configSpec. clickhouse. config. dictionaries[]. clickhouseSource. password	string Пароль пользователя базы данных ClickHouse.
configSpec. clickhouse. config. dictionaries[]. clickhouseSource. where	string Критерии выбора данных в указанной таблице ClickHouse.
configSpec. clickhouse. config. dictionaries[]. mongodbSource	object MongoDB-источник для словаря. `configSpec.clickhouse.config.dictionaries[]` включает только одно из полей `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
configSpec. clickhouse. config. dictionaries[]. mongodbSource. db	string Обязательное поле. Имя базы данных MongoDB.
configSpec. clickhouse. config. dictionaries[]. mongodbSource. collection	string Обязательное поле. Имя коллекции в указанной базе данных, которую следует использовать в качестве источника словаря.
configSpec. clickhouse. config. dictionaries[]. mongodbSource. host	string Обязательное поле. Хост MongoDB для указанной базы данных. Максимальная длина строки в символах — 253.
configSpec. clickhouse. config. dictionaries[]. mongodbSource. port	string (int64) Порт для подключения к хосту. Допустимые значения — от 0 до 65535 включительно.
configSpec. clickhouse. config. dictionaries[]. mongodbSource. user	string Обязательное поле. Имя пользователя базы данных MongoDB.
configSpec. clickhouse. config. dictionaries[]. mongodbSource. password	string Пароль пользователя базы данных MongoDB.
configSpec. clickhouse. config. dictionaries[]. postgresqlSource	object PostgreSQL-источник для словаря. `configSpec.clickhouse.config.dictionaries[]` включает только одно из полей `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
configSpec. clickhouse. config. dictionaries[]. postgresqlSource. db	string Обязательное поле. Имя базы данных PostrgreSQL.
configSpec. clickhouse. config. dictionaries[]. postgresqlSource. table	string Обязательное поле. Имя таблицы в указанной базе данных, используемой в качестве источника словаря.
configSpec. clickhouse. config. dictionaries[]. postgresqlSource. hosts[]	string Обязательное поле. Имя хоста PostrgreSQL. Должен содержать хотя бы один элемент.
configSpec. clickhouse. config. dictionaries[]. postgresqlSource. port	string (int64) Порт для подключения к хосту. Допустимые значения — от 0 до 65535 включительно.
configSpec. clickhouse. config. dictionaries[]. postgresqlSource. user	string Обязательное поле. Имя пользователя базы данных PostrgreSQL.
configSpec. clickhouse. config. dictionaries[]. postgresqlSource. password	string Пароль пользователя базы данных PostrgreSQL.
configSpec. clickhouse. config. dictionaries[]. postgresqlSource. invalidateQuery	string Запрос на проверку состояния словаря, который позволит извлекать только обновленные данные. Дополнительные сведения см. в документации ClickHouse on dictionaries.
configSpec. clickhouse. config. dictionaries[]. postgresqlSource. sslMode	string Режим SSL TCP/IP соединения с хостом PostgreSQL. Дополнительные сведения см. в PostgreSQL documentation. DISABLE: SSL-соединение не используется. ALLOW: Сначала предпринимается попытка установить незашифрованное соединение. Если это не удается, устанавливается SSL-соединение. PREFER: Сначала предпринимается попытка установить SSL-соединение. Если это не удается, устанавливается незашифрованное соединение. VERIFY_CA: Устанавливается только SSL-соединение и только при условии, что сертификат выдан доверенным центром сертификации (CA). VERIFY_FULL: Устанавливается только SSL-соединение и только при условии, что сертификат выдан доверенным центром сертификации и что имя хоста сервера совпадает с указанным в сертификате.
configSpec. clickhouse. config. graphiteRollup[]	object Параметры свертки для движка таблицы GraphiteMergeTree.
configSpec. clickhouse. config. graphiteRollup[]. name	string Обязательное поле. Имя указанной комбинации параметров для свертки Graphite.
configSpec. clickhouse. config. graphiteRollup[]. patterns[]	object Обязательное поле. Шаблон, используемый для свертки. Должен содержать хотя бы один элемент.
configSpec. clickhouse. config. graphiteRollup[]. patterns[]. regexp	string Шаблон для имен метрик.
configSpec. clickhouse. config. graphiteRollup[]. patterns[]. function	string Обязательное поле. Имя агрегирующей функции, которую следует применить к данным старше возраста, указанного в "`retention`".
configSpec. clickhouse. config. graphiteRollup[]. patterns[]. retention[]	object Обязательное поле. Возраст данных, которые следует использовать для прореживания. Должен содержать хотя бы один элемент.
configSpec. clickhouse. config. graphiteRollup[]. patterns[]. retention[]. age	string (int64) Минимальный возраст данных в секундах. Значение должно быть больше 0.
configSpec. clickhouse. config. graphiteRollup[]. patterns[]. retention[]. precision	string (int64) Точность определения возраста данных, в секундах. Значение должно быть больше 0.
configSpec. clickhouse. config. maxConnections	integer (int64) Максимальное количество входящих подключений. Минимальное значение — 10.
configSpec. clickhouse. config. maxConcurrentQueries	integer (int64) Максимальное количество одновременно обрабатываемых запросов. Минимальное значение — 10.
configSpec. clickhouse. config. keepAliveTimeout	integer (int64) Количество миллисекунд, в течение которых ClickHouse ожидает входящие запросы прежде чем закрыть подключение.
configSpec. clickhouse. config. uncompressedCacheSize	integer (int64) Размер кэша (в байтах) для несжатых данных, используемых таблицами MergeTree. См. подробное описание в документации ClickHouse.
configSpec. clickhouse. config. markCacheSize	integer (int64) Примерный размер (в байтах) кэша «меток», используемых таблицами MergeTree. Подробнее в документации ClickHouse. Значение должно быть больше 5368709120.
configSpec. clickhouse. config. maxTableSizeToDrop	integer (int64) Максимальный размер таблицы, которую можно удалить с помощью запроса DROP. См. подробное описание в документации ClickHouse.
configSpec. clickhouse. config. maxPartitionSizeToDrop	integer (int64) Максимальный размер раздела, который можно удалить с помощью запроса DROP. См. подробное описание в документации ClickHouse.
configSpec. clickhouse. config. builtinDictionariesReloadInterval	integer (int64) Параметр устарел и не имеет никакого эффекта.
configSpec. clickhouse. config. timezone	string Часовой пояс сервера, используемый в преобразованиях полей DateTime. Указывается как идентификатор IANA. См. подробное описание в документации ClickHouse.
configSpec. clickhouse. config. geobaseUri	string
configSpec. clickhouse. resources	object Ресурсы, выделенные хостам ClickHouse.
configSpec. clickhouse. resources. resourcePresetId	string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
configSpec. clickhouse. resources. diskSize	string (int64) Объем хранилища, доступного хосту, в байтах.
configSpec. clickhouse. resources. diskTypeId	string Тип хранилища для хоста. Возможные значения: network-hdd — сетевой HDD-диск; network-ssd — сетевой SSD-диск; local-ssd — локальное SSD-хранилище.
configSpec. zookeeper	object Конфигурация и ресурсы для сервера ZooKeeper.
configSpec. zookeeper. resources	object Ресурсы, выделенные хостам ZooKeeper. Если не задано, будет использоваться минимальный доступный набор ресурсов. Все доступные наборы ресурсов можно получить с помощью запроса list.
configSpec. zookeeper. resources. resourcePresetId	string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
configSpec. zookeeper. resources. diskSize	string (int64) Объем хранилища, доступного хосту, в байтах.
configSpec. zookeeper. resources. diskTypeId	string Тип хранилища для хоста. Возможные значения: network-hdd — сетевой HDD-диск; network-ssd — сетевой SSD-диск; local-ssd — локальное SSD-хранилище.
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. access	object Политика доступа для внешних сервисов. Если вы хотите, чтобы определенный сервис получил доступ к кластеру ClickHouse — задайте необходимые значения в этой политике.
configSpec. access. dataLens	boolean (boolean) Разрешить экспорт данных из кластера в Yandex DataLens.
configSpec. access. webSql	boolean (boolean) Разрешить SQL-запросы к базам данных кластера из консоли управления облаком. Подробнее см. в SQL-запросы в консоли управления.
configSpec. access. metrika	boolean (boolean) Разрешить импорт данных из Яндекс.Метрики и AppMetrica в кластер. Подробнее см. в Экспорт данных в Яндекс.Облако.
configSpec. access. serverless	boolean (boolean) Разрешить доступ к кластеру для Serverless.
databaseSpecs[]	object Обязательное поле. Описания баз данных, которые нужно создать в кластере ClickHouse. Должен содержать хотя бы один элемент.
databaseSpecs[]. name	string Обязательное поле. Имя базы данных ClickHouse. Длина 1-63 символов. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению `[a-zA-Z0-9_-]*`.
userSpecs[]	object Обязательное поле. Описания пользователей базы данных, которых нужно создать в кластере ClickHouse. Должен содержать хотя бы один элемент.
userSpecs[]. name	string Обязательное поле. Имя пользователя базы данных ClickHouse. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению `[a-zA-Z0-9_]*`.
userSpecs[]. password	string Обязательное поле. Пароль пользователя ClickHouse. Длина строки в символах должна быть от 8 до 128.
userSpecs[]. permissions[]	object Набор разрешений, которые следует предоставить пользователю.
userSpecs[]. permissions[]. databaseName	string Имя базы данных, к которой предоставляет доступ разрешение.
userSpecs[]. settings	object Пользовательские настройки ClickHouse. Поддерживаемые параметры входят в число параметров, описанных в документации ClickHouse.
userSpecs[]. settings. readonly	integer (int64) Ограничивает разрешения для запросов, не относящихся к DDL. Чтобы ограничить разрешения для DDL-запросов, используйте настройку `allowDdl`. `0` (по умолчанию) — нет ограничений. `1`— разрешено выполнять только запросы на чтение данных. `2` — разрешено выполнять запросы на чтение данных и изменение настроек. См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно.
userSpecs[]. settings. allowDdl	boolean (boolean) Определяет, разрешены ли DDL-запросы (например, `CREATE`, `ALTER`, `RENAME`, и т.д.). Значение по умолчанию: `true`. См. подробное описание в документации ClickHouse.
userSpecs[]. settings. insertQuorum	integer (int64) Включает или выключает кворумную запись в кластере ClickHouse. Если значение меньше `2`, то кворумная запись выключена, в противном случае она включена. Кворумная запись позволяет гарантировать, что за время, не большее чем `insertQuorumTimeout`, ClickHouse смог без ошибок записать данные в кворум из `insert_quorum` реплик. Все реплики в кворуме консистентны, т.е. содержат данные всех более ранних запросов `INSERT`. Использование кворума при записи позволяет гарантировать, что данные не потеряются при выходе из строя одной или нескольких реплик. При чтении данных, записанных с помощью кворумной записи, можно использовать настройку `selectSequentialConsistency`. См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. connectTimeout	integer (int64) Время ожидания соединения в миллисекундах. Значение должно быть больше `0` (по умолчанию: `10000`, 10 секунд). Значение должно быть больше 0.
userSpecs[]. settings. receiveTimeout	integer (int64) Время ожидания приема данных в миллисекундах. Значение должно быть больше `0` (по умолчанию: `300000`, 300 секунд, 5 минут). Значение должно быть больше 0.
userSpecs[]. settings. sendTimeout	integer (int64) Время ожидания отправки данных в миллисекундах. Значение должно быть больше `0` (по умолчанию: `300000`, 300 секунд, 5 минут). Значение должно быть больше 0.
userSpecs[]. settings. insertQuorumTimeout	integer (int64) Время ожидания кворумной записи в миллисекундах. Если кворумная запись включена, время ожидания прошло, а запись в `insertQuorum` реплик так не состоялась, то ClickHouse прервет выполнение `INSERT`-запроса и вернет ошибку. В этом случае клиент должен повторить запрос на запись того же блока на эту же или любую другую реплику. Минимальное значение: `1000`, одна секунда (по умолчанию: `60000`, одна минута). Минимальное значение — 1000.
userSpecs[]. settings. selectSequentialConsistency	boolean (boolean) Определяет поведение `SELECT`-запросов для реплицированных таблиц: если эта настройка включена, ClickHouse прервет выполнение запроса и вернет сообщение об ошибке в случае, если в реплике нет фрагментов данных, записанных с помощью кворумной записи. Фрагменты данных, записанные без использования кворумной записи, прочитаны не будут. Значение по умолчанию: `false` (последовательная консистентность выключена).
userSpecs[]. settings. maxReplicaDelayForDistributedQueries	integer (int64) Максимальная задержка реплики в миллисекундах. Если реплика отстает на значение больше установленного, она перестает использоваться и становится устаревшей. Минимальное значение: `1000`, 1 секунда (по умолчанию: `300000`, 300 секунд, 5 минут). См. подробное описание в документации ClickHouse. Минимальное значение — 1000.
userSpecs[]. settings. fallbackToStaleReplicasForDistributedQueries	boolean (boolean) Включает или выключает форсирование запроса в устаревшую реплику в случае, если актуальные данные недоступны. Если этот параметр включен, то из устаревших реплик таблицы ClickHouse выбирает наиболее актуальную. Используется при выполнении `SELECT` из распределенной таблицы, которая указывает на реплицированные таблицы. Значение по умолчанию: `true` (форсирование запроса включено). См. подробное описание в документации ClickHouse.
userSpecs[]. settings. replicationAlterPartitionsSync	integer (int64) Условия ожидания завершения асинхронных действий на репликах для запросов `ALTER`: `0` — не ждать. `1` — ждать выполнения только у себя (значение по умолчанию). `2` — ждать всех. См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно.
userSpecs[]. 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: Позволяет использовать эти типы подзапросов.
userSpecs[]. settings. distributedAggregationMemoryEfficient	boolean (boolean) Включает или выключает режим экономии памяти при распределенной агрегации. При распределённой обработке запроса внешняя агрегация производится на удалённых серверах. Для того чтобы на сервере-инициаторе запроса использовалось немного оперативной памяти, нужно включить эту настройку. Значение по умолчанию: `false` (режим экономии памяти выключен). См. подробное описание в документации ClickHouse.
userSpecs[]. settings. distributedDdlTaskTimeout	integer (int64) Время ожидания выполнения DDL-запросов в миллисекундах.
userSpecs[]. settings. skipUnavailableShards	boolean (boolean) Включает или выключает тихий пропуск недоступных шардов. Шард считается недоступным, если все его реплики недоступны. Значение по умолчанию: `false` (тихий пропуск недоступных шардов выключен). См. подробное описание в документации ClickHouse.
userSpecs[]. settings. compile	boolean (boolean) Включает или выключает компиляцию запросов. Если вы выполняете большое количество структурно идентичных запросов — включите эту настройку. При включенной компиляции такие запросы могут выполняться быстрее за счет использования скомпилированных частей запроса. Эта настройка используется совместно с `minCountToCompile`. Значение по умолчанию: `false` (компиляция выключена). См. подробное описание в документации ClickHouse.
userSpecs[]. settings. minCountToCompile	integer (int64) После какого количества структурно идентичных запросов начать компиляцию. Минимальное значение: `0` (по умолчанию: `3`). Для значения `0` компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования. Для всех других значений компиляция выполняется асинхронно, в отдельном потоке. Когда часть запроса будет скомпилирована, она сразу же будет использована ClickHouse для подходящих запросов (включая те, которые выполняются в данный момент). См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. compileExpressions	boolean (boolean) Включает или выключает компиляцию выражений. Если вы выполняете большое количество запросов, в которых используются идентичные выражения — включите эту настройку. При включенной компиляции выражений такие запросы могут выполняться быстрее за счет использования скомпилированных выражений. Эта настройка используется совместно с `minCountToCompileExpression`. Значение по умолчанию: `false` (компиляция выражений выключена).
userSpecs[]. settings. minCountToCompileExpression	integer (int64) После какого количества идентичных выражений начать их компиляцию. Минимальное значение: `0` (по умолчанию: `3`). Для значения `0` компиляция выполняется синхронно: запрос ожидает окончания процесса компиляции выражения перед продолжением выполнения. Рекомендуется использовать это значение только в целях тестирования. Для всех других значений компиляция выполняется асинхронно, в отдельном потоке. Когда выражение будет скомпилировано, оно сразу же будет использовано ClickHouse для подходящих запросов (включая те, которые выполняются в данный момент). Минимальное значение — 0.
userSpecs[]. settings. maxBlockSize	integer (int64) Максимальный размер блока для чтения. Данные в ClickHouse обрабатываются по блокам (наборам кусочков столбцов). Внутренние циклы обработки для одного блока достаточно эффективны, но есть заметные издержки на каждый блок. Эта настройка — рекомендация, какой размер блока (в количестве строк) загружать из таблиц. Значение должно быть больше `0` (по умолчанию: `65536`). См. подробное описание в документации ClickHouse. Значение должно быть больше 0.
userSpecs[]. settings. minInsertBlockSizeRows	integer (int64) Ограничивает минимальное количество строк в блоке, который может быть вставлен в таблицу запросом `INSERT`. Блоки меньшего размера склеиваются в блоки большего размера. Минимальное значение: `0`, склейка блоков выключена (по умолчанию: `1048576`). Минимальное значение — 0.
userSpecs[]. settings. minInsertBlockSizeBytes	integer (int64) Ограничивает минимальное количество байтов в блоке, который может быть вставлен в таблицу запросом `INSERT`. Блоки меньшего размера склеиваются в блоки большего размера. Минимальное значение: `0`, склейка блоков выключена (по умолчанию: `‭268435456‬‬`, 256 МБ). Минимальное значение — 0.
userSpecs[]. settings. maxInsertBlockSize	integer (int64) Позволяет формировать блоки указанного размера (в байтах) при вставке в таблицу. Эта настройка действует только в тех случаях, когда сервер сам формирует такие блоки. Значение должно быть больше `0` (по умолчанию: `1048576`). См. подробное описание в документации ClickHouse. Значение должно быть больше 0.
userSpecs[]. settings. minBytesToUseDirectIo	integer (int64) минимальный объём данных в байтах, необходимый для прямого (небуферизованного) чтения (Direct I/O) на диск. По умолчанию ClickHouse читает данные не напрямую с диска, а полагается на файловую систему и её кэш. Такое чтение эффективно при небольших объемах данных. Если данные читаются в больших объемах, эффективнее читать с диска напрямую, минуя кэш файловой системы. Если общий объём хранения всех данных для чтения превышает заданное значение настройки, тогда ClickHouse читает данные с диска напрямую. Минимальное значение и значение по умолчанию: `0` (прямой ввод/вывод отключен). Минимальное значение — 0.
userSpecs[]. settings. useUncompressedCache	boolean (boolean) Определяет, использовать ли кэш разжатых блоков. Использование кэша несжатых блоков может существенно сократить задержку и увеличить пропускную способность при работе с большим количеством коротких запросов. Включите эту настройку для пользователей, от которых идут частые короткие запросы. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: `false` (кэш не используется). См. подробное описание в документации ClickHouse.
userSpecs[]. settings. mergeTreeMaxRowsToUseCache	integer (int64) Ограничивает максимальный размер запроса в строках для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанный размер. Эта настройка используется совместно с `useUncompressedCache`. Значение должно быть больше `0` (по умолчанию: `128x8192`). Значение должно быть больше 0.
userSpecs[]. settings. mergeTreeMaxBytesToUseCache	integer (int64) Ограничивает максимальный размер запроса в байтах для использования кэша несжатых данных. Кэш не используется для запросов, превышающих указанный размер. Эта настройка используется совместно с `useUncompressedCache`. Значение должно быть больше `0` (по умолчанию: `192x10x1024x1024`). Значение должно быть больше 0.
userSpecs[]. settings. mergeTreeMinRowsForConcurrentRead	integer (int64) Ограничивает минимальное количество строк, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество строк, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков. Этот настройка действует только для таблиц семейства MergeTree. Значение должно быть больше `0` (по умолчанию: `20x8192`). Значение должно быть больше 0.
userSpecs[]. settings. mergeTreeMinBytesForConcurrentRead	integer (int64) Ограничивает минимальное количество байт, которое надо прочитать из файла, чтобы использовать одновременное чтение. Если количество байт, прочитанных из файла, превышает заданное значение, то ClickHouse пытается выполнить одновременное чтение из этого файла в несколько потоков. Этот настройка действует только для таблиц семейства MergeTree. Значение должно быть больше `0` (по умолчанию: `24x10x1024x1024`). Значение должно быть больше 0.
userSpecs[]. settings. maxBytesBeforeExternalGroupBy	integer (int64) задает порог потребления оперативной памяти (в байтах), по достижению которого временные данные, накопленные при выполнении операции агрегации `GROUP BY`, сбрасываются на диск для экономии оперативной памяти. По умолчанию агрегирование выполняется в памяти с помощью хэш-таблицы. Запрос может привести к необходимости агрегации больших объемов данных, которые могут не поместиться в оперативную память и вызвать ошибку при выполнении запроса (см. настройку `maxMemoryUsage`). Для таких запросов используйте эту настройку, чтобы ClickHouse сбрасывал данные на диск и успешно выполнял агрегацию. Минимальное значение и значение по умолчанию: `0`, `GROUP BY` во внешней памяти отключен. При использовании агрегации во внешней памяти рекомендуется задать значение этой настройки в два раза меньше значения настройки `maxMemoryUsage` (по умолчанию максимальное использование памяти ограничено десятью гигабайтами). См. подробное описание в документации ClickHouse. Смотрите также настройку `distributedAggregationMemoryEfficient`.
userSpecs[]. settings. maxBytesBeforeExternalSort	integer (int64) Настройка аналогична `maxBytesBeforeExternalGroupBy`, за исключением того, что она применяется для операции сортировки (`ORDER BY`).
userSpecs[]. settings. groupByTwoLevelThreshold	integer (int64) Определяет порог количества ключей, при достижении которого начинается двухуровневая агрегация. Минимальное значение: `0`, порог не установлен (по умолчанию: `10000‬‬`).
userSpecs[]. settings. groupByTwoLevelThresholdBytes	integer (int64) Определяет порог количества байт в агрегате, при достижении которого начинается двухуровневая агрегация. Минимальное значение: `0`, порог не установлен (по умолчанию: `100000000‬‬`).
userSpecs[]. settings. priority	integer (int64) Определяет приоритет запроса. `0` — приоритет не используется. `1` — наивысший приоритет. и так далее. Чем больше число, тем ниже приоритет. Эта настройка выставляется для каждого запроса по отдельности. Если ClickHouse в текущий момент времени выполняет запросы с более высокими приоритетами, чем приоритет поступившего запроса, то выполнение такого запроса приостанавливается до завершения выполнения более приоритетных запросов. Минимальное значение и значение по умолчанию: `0`, приоритет не используется. Минимальное значение — 0.
userSpecs[]. settings. maxThreads	integer (int64) Ограничивает максимальное количество потоков обработки запроса (без учёта потоков для чтения данных с удалённых серверов). Этот параметр относится к потокам, которые выполняют параллельно одни стадии конвейера выполнения запроса. Минимальное значение и значение по умолчанию: `0` (значение вычисляется автоматически — это количество процессорных ядер без учёта Hyper-Threading). См. подробное описание в документации ClickHouse. Значение должно быть больше 0.
userSpecs[]. settings. maxMemoryUsage	integer (int64) Ограничивает максимально возможный объём оперативной памяти (в байтах) для выполнения запроса на одном сервере. Настройка не учитывает объём свободной памяти или общий объём памяти на машине. Ограничение действует на один запрос, в пределах одного сервера. Минимальное значение: `0`, нет ограничения. В конфигурационном файле по умолчанию ограничение равно `10737418240` (10 ГБ). Если вы также используете настройки `maxBytesBeforeExternalGroupBy` или `maxBytesBeforeExternalSort`, рекомендуется, чтобы их значения были в два раза меньше значения `maxMemoryUsage`. См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. maxMemoryUsageForUser	integer (int64) Ограничивает максимально возможный объём оперативной памяти (в байтах) для выполнения запросов пользователя на одном сервере. Настройка не учитывает объём свободной памяти или общий объём памяти на машине. Ограничение действует на все запросы пользователя, которые выполняются одновременно в пределах одного сервера. Минимальное значение и значение по умолчанию: `0`, нет ограничения. Минимальное значение — 0.
userSpecs[]. settings. maxNetworkBandwidth	integer (int64) Ограничивает скорость обмена данными по сети (байт в секунду) при выполнении одного запроса. Минимальное значение и значение по умолчанию: `0`, нет ограничения.
userSpecs[]. settings. maxNetworkBandwidthForUser	integer (int64) Ограничивает скорость обмена данными по сети (байт в секунду). Эта настройка влияет на все одновременно выполняющиеся запросы пользователя. Минимальное значение и значение по умолчанию: `0`, нет ограничения.
userSpecs[]. settings. forceIndexByDate	boolean (boolean) Если эта настройка включена, то запрос не выполняется при условии, что использовать индекс по дате невозможно. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: `false` (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по дате). См. подробное описание в документации ClickHouse.
userSpecs[]. settings. forcePrimaryKey	boolean (boolean) Если эта настройка включена, то запрос не выполняется при условии, что использовать индекс по первичному ключу невозможно. Этот настройка действует только для таблиц семейства MergeTree. Значение по умолчанию: `false` (настройка отключена, запрос выполняется, даже если ClickHouse не может использовать индекс по первичному ключу). См. подробное описание в документации ClickHouse.
userSpecs[]. settings. maxRowsToRead	integer (int64) Ограничивает максимальное количество строк, которое можно прочитать из таблицы при выполнении запроса. Минимальное значение и значение по умолчанию: `0`, нет ограничения. См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. maxBytesToRead	integer (int64) Ограничивает максимальное количество байт (несжатых данных), которое можно прочитать из таблицы при выполнении запроса. Минимальное значение и значение по умолчанию: `0`, нет ограничения. Минимальное значение — 0.
userSpecs[]. settings. readOverflowMode	string Определяет поведение ClickHouse в ситуации, когда количество прочитанных данных превысило ограничения. `throw` — прервать выполнение запроса, вернуть ошибку. `break` — прервать выполнение запроса, вернуть неполный результат.
userSpecs[]. settings. maxRowsToGroupBy	integer (int64) Ограничивает максимальное количество уникальных ключей, получаемых в процессе агрегации. Эта настройка позволяет ограничить потребление оперативной памяти при агрегации. Минимальное значение и значение по умолчанию: `0`, нет ограничения. Минимальное значение — 0.
userSpecs[]. settings. groupByOverflowMode	string Определяет поведение ClickHouse в ситуации, когда количество уникальных ключей при агрегации превысило ограничения. `throw` — прервать выполнение запроса, вернуть ошибку. `break` — прервать выполнение запроса, вернуть неполный результат. `any` — выполнить `GROUP BY` приближённо, продолжая агрегацию для ключей, которые попали в набор, без добавления новых ключей в набор.
userSpecs[]. settings. maxRowsToSort	integer (int64) Ограничивает максимальное количество строк для сортировки. Эта настройка позволяет ограничить потребление оперативной памяти при сортировке. Минимальное значение и значение по умолчанию: `0`, нет ограничения. Минимальное значение — 0.
userSpecs[]. settings. maxBytesToSort	integer (int64) Ограничивает максимальное количество байт (несжатых данных), которое можно прочитать из таблицы до сортировки. Эта настройка позволяет ограничить потребление оперативной памяти при сортировке. Минимальное значение и значение по умолчанию: `0`, нет ограничения. Минимальное значение — 0.
userSpecs[]. settings. sortOverflowMode	string Определяет поведение ClickHouse в ситуации, когда количество строк, полученных перед сортировкой, превысило ограничения. `throw` — прервать выполнение запроса, вернуть ошибку. `break` — прервать выполнение запроса, вернуть неполный результат.
userSpecs[]. settings. maxResultRows	integer (int64) Ограничивает количество строк результата. Это ограничение также проверяется для подзапросов и частей распределенных запросов, выполняемых на удаленных серверах. Минимальное значение и значение по умолчанию: `0`, нет ограничения. Минимальное значение — 0.
userSpecs[]. settings. maxResultBytes	integer (int64) Ограничивает количество байт результата. Это ограничение также проверяется для подзапросов и частей распределенных запросов, выполняемых на удаленных серверах. Минимальное значение и значение по умолчанию: `0`, нет ограничения. Минимальное значение — 0.
userSpecs[]. settings. resultOverflowMode	string определяет поведение ClickHouse в ситуации, когда объём результата превысил ограничения. `throw` — прервать выполнение запроса, вернуть ошибку. `break` — прервать выполнение запроса, вернуть неполный результат.
userSpecs[]. settings. maxRowsInDistinct	integer (int64) Ограничивает максимальное количество различных строк при использовании `DISTINCT`. Минимальное значение и значение по умолчанию: `0`, нет ограничения. Минимальное значение — 0.
userSpecs[]. settings. maxBytesInDistinct	integer (int64) Ограничивает максимальное количество байт (несжатых данных), занимаемых хэш-таблицей, при использовании `DISTINCT`. Минимальное значение — 0.
userSpecs[]. settings. distinctOverflowMode	string Определяет поведение ClickHouse в ситуации, когда количество данных при выполнении запроса `DISTINCT` превысило ограничения. `throw` — прервать выполнение запроса, вернуть ошибку. `break` — прервать выполнение запроса, вернуть неполный результат.
userSpecs[]. settings. maxRowsToTransfer	integer (int64) Ограничивает максимальное количество строк, которое можно передать на удалённый сервер или сохранить во временную таблицу при использовании `GLOBAL IN`. Минимальное значение и значение по умолчанию: `0`, нет ограничения. Минимальное значение — 0.
userSpecs[]. settings. maxBytesToTransfer	integer (int64) Ограничивает максимальное количество байт (несжатых данных), которых можно передать на удалённый сервер или сохранить во временную таблицу, при использовании `GLOBAL IN`. Минимальное значение и значение по умолчанию: `0`, нет ограничения. Минимальное значение — 0.
userSpecs[]. settings. transferOverflowMode	string Определяет поведение ClickHouse в ситуации, когда количество данных для передачи на другой сервер превысило ограничения. `throw` — прервать выполнение запроса, вернуть ошибку. `break` — прервать выполнение запроса, вернуть неполный результат.
userSpecs[]. settings. maxExecutionTime	integer (int64) Ограничивает максимальное время выполнения запроса в миллисекундах. На данный момент это ограничение не проверяется при одной из стадий сортировки а также при слиянии и финализации агрегатных функций. Минимальное значение и значение по умолчанию: `0`, нет ограничения. Минимальное значение — 0.
userSpecs[]. settings. timeoutOverflowMode	string Определяет поведение ClickHouse в ситуации, когда запрос превысил ограничения на время исполнения. `throw` — прервать выполнение запроса, вернуть ошибку. `break` — прервать выполнение запроса, вернуть неполный результат.
userSpecs[]. settings. maxColumnsToRead	integer (int64) Ограничивает максимальное количество столбцов, которые можно читать из таблицы в одном запросе. Если запрос требует чтения большего количества столбцов — он будет завершен с ошибкой. Минимальное значение и значение по умолчанию: `0`, нет ограничения. Минимальное значение — 0.
userSpecs[]. settings. maxTemporaryColumns	integer (int64) Ограничивает максимальное количество временных столбцов, которое должно храниться в оперативной памяти одновременно при выполнении запроса (с учетом постоянных столбцов) Минимальное значение и значение по умолчанию: `0`, нет ограничения. Минимальное значение — 0.
userSpecs[]. settings. maxTemporaryNonConstColumns	integer (int64) Ограничивает максимальное количество временных столбцов, которое должно храниться в оперативной памяти одновременно при выполнении запроса (без учета постоянных столбцов). Минимальное значение и значение по умолчанию: `0`, нет ограничения. Минимальное значение — 0.
userSpecs[]. settings. maxQuerySize	integer (int64) Ограничивает размер наибольшей части запроса (в байтах), которая может быть передана в оперативную память для разбора с помощью парсера SQL. Значение должно быть больше `0` (по умолчанию: `262144`). См. подробное описание в документации ClickHouse. Значение должно быть больше 0.
userSpecs[]. settings. maxAstDepth	integer (int64) Ограничивает максимальную глубину вложенности синтаксического дерева. Для больших и сложных запросов может быть построено синтаксическое дерево очень большой глубины. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Например, запрос `SELECT *` в большинстве случаев породит более сложное и глубокое синтаксическое дерево, чем запрос `SELECT ... WHERE ...` с ограничениями и условиями. Наложение ограничения с помощью настройки может побудить пользователя оптимизировать излишне сложные запросы. Значение должно быть больше `0` (по умолчанию: `1000`). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. См. подробное описание в документации ClickHouse. Значение должно быть больше 0.
userSpecs[]. settings. maxAstElements	integer (int64) Ограничивает максимальное количество элементов синтаксического дерева запроса (количество узлов дерева). Для больших и сложных запросов может быть построено синтаксическое дерево c очень большим количеством элементов. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Значение должно быть больше `0` (по умолчанию: `50000`). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. См. подробное описание в документации ClickHouse. Значение должно быть больше 0.
userSpecs[]. settings. maxExpandedAstElements	integer (int64) Ограничивает максимальное количество элементов синтаксического дерева запроса (количество узлов дерева) после раскрытия псевдонимов и звездочки. Для больших и сложных запросов может быть построено синтаксическое дерево c очень большим количеством элементов. При помощи этой настройки вы можете запретить выполнение излишне больших или неоптимальных запросов для больших таблиц. Значение должно быть больше `0` (по умолчанию: `500000`). Слишком маленькое значение может привести к невозможности выполнения большинства запросов. Значение должно быть больше 0.
userSpecs[]. settings. inputFormatValuesInterpretExpressions	boolean (boolean) Включает или выключает парсер SQL, если потоковый парсер не может проанализировать данные. Используйте эту настройку, если значения, которые вы хотите вставить в таблицу, содержат в себе выражения SQL. Например, при вставке в таблицу значения, содержащего в себе выражение `now()`, потоковый парсер не сможет распознать это выражение; запрос `INSERT` завершится с ошибкой, и никакие данные не будут вставлены в таблицу. При включенном парсере SQL выражение будет распознано корректно и в качестве значения будет вставлен результат выполнения SQL-функции `now()` (текущая дата и время). Эта настройка действует только в том случае, если вы используете формат Values при вставке данных. Значение по умолчанию: `true` (парсер SQL включен). См. подробное описание в документации ClickHouse.
userSpecs[]. settings. inputFormatDefaultsForOmittedFields	boolean (boolean) Включает или выключает замену пропущенных полей значениями по умолчанию для типа данных столбца при вставке данных запросом `INSERT`. Значение по умолчанию: `true` (замена включена).
userSpecs[]. settings. outputFormatJsonQuote_64BitIntegers	boolean (boolean) Определяет формат чисел в JSON-выводе. Если эта настройка включена, то при выводе в JSON 64-битные числа (`UInt64` и `Int64`) выводятся в кавычках (из соображений совместимости с большинством реализаций JavaScript). Иначе — без кавычек. Значение по умолчанию: `false` (вывод 64-битных целых чисел в кавычках выключен).
userSpecs[]. settings. outputFormatJsonQuoteDenormals	boolean (boolean) Включает вывод специальных значений для чисел с плавающей запятой (`+nan`, `-nan`, `+inf` и `-inf`) при выводе в JSON. Значение по умолчанию: `false` (специальные значения не выводятся).
userSpecs[]. settings. lowCardinalityAllowInNativeFormat	boolean (boolean) Определяет, использовать ли тип LowCardinality в Native-формате. `true` (по умолчанию) — да, использовать. `false`— конвертировать столбцы LowCardinality в обычные столбцы для запроса `SELECT`, и конвертировать обычные столбцы в требуемый LowCardinality-столбец для запроса `INSERT`. Столбцы этого типа, также известные как «разреженные столбцы», позволяют более эффективно хранить данные в виде хэш-таблиц. Если данные это позволяют, ClickHouse использует столбец типа LowCardinality. Если вы используете сторонний клиент для ClickHouse, который не умеет работать со столбцами типа LowCardinality, то такой клиент не сможет правильно интерпретировать результат запроса, если в запросе будет присутствовать столбец типа LowCardinality. Выключите эту настройку, чтобы включать в результат столбец в обычном формате и позволить сторонним клиентам обработать результат. Официальный клиент ClickHouse умеет работать со столбцами типа LowCardinality. Значение по умолчанию: `true` (столбцы LowCardinality используются в Native-формате).
userSpecs[]. settings. emptyResultForAggregationByEmptySet	boolean (boolean) Позволяет возвращать пустой результат при выполнении агрегации данных без ключей (без `GROUP BY`) для пустого множества (например, `SELECT count(*) FROM table WHERE 0`). `true`— ClickHouse вернет пустой результат. `false` (по умолчанию) — ClickHouse вернет результат, состоящий из одной строки со значениями `NULL` для агрегатных функций, в соответствии со стандартом SQL.
userSpecs[]. settings. httpConnectionTimeout	integer (int64) Время ожидания установления HTTP-соединения в миллисекундах. Значение должно быть больше `0` (по умолчанию: `1000`, 1 секунда).
userSpecs[]. settings. httpReceiveTimeout	integer (int64) Время ожидания приема данных через HTTP-соединение в миллисекундах. Значение должно быть больше `0` (по умолчанию: `1800000`, 1800 секунд, 30 минут).
userSpecs[]. settings. httpSendTimeout	integer (int64) Время ожидания отправки данных через HTTP-соединение в миллисекундах. Значение должно быть больше `0` (по умолчанию: `1800000`, 1800 секунд, 30 минут).
userSpecs[]. settings. enableHttpCompression	boolean (boolean) Включает или выключает сжатие данных в ответе на HTTP-запрос. По умолчанию ClickHouse хранит данные в сжатом виде. При выполнении запроса его результат представлен в несжатом виде. С помощью этой настройки вы можете указать ClickHouse сжимать результат запроса при отправке по HTTP. Чтобы ClickHouse сжал ответ при включенной настройке, добавьте в HTTP-запрос заголовок @b. ClickHouse поддерживает следующие методы сжатия: `gzip`, `br` и `deflate`. Значение по умолчанию: `false` (сжатие выключено). См. подробное описание в документации ClickHouse.
userSpecs[]. settings. sendProgressInHttpHeaders	boolean (boolean) Включает отсылку уведомления о ходе выполнения с использованием HTTP-заголовков `X-ClickHouse-Progress`. Значение по умолчанию: `false` (отсылка уведомлений выключена).
userSpecs[]. settings. httpHeadersProgressInterval	integer (int64) Задает минимальный интервал (в миллисекундах) между уведомлениями о ходе выполнения запроса с помощью HTTP-заголовка `X-ClickHouse-Progress`. Значение должно быть больше `0` (по умолчанию: `100`).
userSpecs[]. settings. addHttpCorsHeader	boolean (boolean) Включает заголовок CORS в HTTP-ответы. Значение по умолчанию: `false` (заголовок не включается в HTTP-ответы).
userSpecs[]. quotas[]	object Представление квот ClickHouse. Каждая квота связана с пользователем и ограничивает использование ресурсов на определенный интервал. См. подробное описание в документации ClickHouse.
userSpecs[]. quotas[]. intervalDuration	integer (int64) Длительность интервала для квоты в миллисекундах. Минимальное значение — 1 секунда. Минимальное значение — 1000.
userSpecs[]. quotas[]. queries	integer (int64) Общее количество запросов. 0-неограниченно. Минимальное значение — 0.
userSpecs[]. quotas[]. errors	integer (int64) Количество запросов, которые вызвали исключение. 0-неограниченно. Минимальное значение — 0.
userSpecs[]. quotas[]. resultRows	integer (int64) Общее число строк, приведенных в результате. 0-неограниченно. Минимальное значение — 0.
userSpecs[]. quotas[]. readRows	integer (int64) Общее число исходных строк, считанных из таблиц для выполнения запроса, на всех удаленных серверах. 0-неограниченно. Минимальное значение — 0.
userSpecs[]. quotas[]. executionTime	integer (int64) Общее время выполнения запроса, в миллисекундах. 0-неограниченно. Минимальное значение — 0.
hostSpecs[]	object Обязательное поле. Конфигурации для отдельных хостов, которые должны быть созданы для кластера ClickHouse. Должен содержать хотя бы один элемент.
hostSpecs[]. zoneId	string Идентификатор зоны доступности, в которой находится хост. Чтобы получить список доступных зон, используйте запрос list. Максимальная длина строки в символах — 50.
hostSpecs[]. type	string Обязательное поле. Тип развертываемого хоста. CLICKHOUSE: Хост ClickHouse. ZOOKEEPER: Хост ZooKeeper.
hostSpecs[]. subnetId	string Идентификатор подсети, к которой должен принадлежать хост. Эта подсеть должна быть частью сети, к которой принадлежит кластер. Идентификатор сети задается в поле Cluster.networkId. Максимальная длина строки в символах — 50.
hostSpecs[]. assignPublicIp	boolean (boolean) Должен ли хост получить публичный IP-адрес при создании. После создания узла этот параметр изменить нельзя. Чтобы удалить назначенный публичный IP-адрес или назначить публичный IP уже созданному хосту, пересоздайте хост с нужным значением поля `assignPublicIp`. Возможные значения: false — не назначать хосту публичный IP-адрес. true — у хоста должен быть публичный IP-адрес.
hostSpecs[]. shardName	string Имя шарда, которому принадлежит хост. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению `[a-zA-Z0-9_-]*`.
networkId	string Обязательное поле. Идентификатор сети, в которой нужно создать кластер. Максимальная длина строки в символах — 50.
shardName	string Имя первого шарда в кластере. Если параметр не указан, используется значение `shard1`. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению `[a-zA-Z0-9_-]*`.
serviceAccountId	string Идентификатор сервисного аккаунта, используемого для доступа к Yandex Object Storage.

Ответ

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`.