Метод 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"
    }
  },
  "databaseSpecs": [
    {
      "name": "string"
    }
  ],
  "userSpecs": [
    {
      "name": "string",
      "password": "string",
      "permissions": [
        {
          "databaseName": "string"
        }
      ],
      "settings": {
        "readonly": "integer",
        "allowDdl": true,
        "insertQuorum": "integer",
        "insertQuorumTimeout": "integer",
        "selectSequentialConsistency": true,
        "maxReplicaDelayForDistributedQueries": "integer",
        "fallbackToStaleReplicasForDistributedQueries": true,
        "maxThreads": "integer",
        "maxBlockSize": "integer",
        "maxInsertBlockSize": "integer",
        "maxMemoryUsage": "integer",
        "maxMemoryUsageForUser": "integer",
        "maxRowsToRead": "integer",
        "maxBytesToRead": "integer",
        "readOverflowMode": "string",
        "maxRowsToGroupBy": "integer",
        "groupByOverflowMode": "string",
        "maxRowsToSort": "integer",
        "maxBytesToSort": "integer",
        "sortOverflowMode": "string",
        "maxResultRows": "integer",
        "maxResultBytes": "integer",
        "resultOverflowMode": "string",
        "maxRowsInDistinct": "integer",
        "maxBytesInDistinct": "integer",
        "distinctOverflowMode": "string",
        "maxRowsToTransfer": "integer",
        "maxBytesToTransfer": "integer",
        "transferOverflowMode": "string",
        "maxExecutionTime": "integer",
        "timeoutOverflowMode": "string",
        "maxColumnsToRead": "integer",
        "maxTemporaryColumns": "integer",
        "maxTemporaryNonConstColumns": "integer",
        "maxQuerySize": "integer",
        "maxAstDepth": "integer",
        "maxAstElements": "integer",
        "maxExpandedAstElements": "integer"
      }
    }
  ],
  "hostSpecs": [
    {
      "zoneId": "string",
      "type": "string",
      "subnetId": "string",
      "assignPublicIp": true,
      "shardName": "string"
    }
  ],
  "networkId": "string",
  "shardName": "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.
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.
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.
configSpec. clickhouse. config. dictionaries[]. postgresqlSource. sslMode	string Режим SSL TCP/IP соединения с хостом PostgreSQL. Дополнительные сведения см. в документации PostgreSQL. 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.type.Date] и `google.protobuf.Timestamp`.
configSpec. backupWindowStart. hours	integer (int32) Час в 24-часовом формате. Допустимые значения — от 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 до 999 999 999.
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) См. подробное описание в документации ClickHouse. Допустимые значения — от 0 до 2 включительно.
userSpecs[]. settings. allowDdl	boolean (boolean) См. подробное описание в документации ClickHouse.
userSpecs[]. settings. insertQuorum	integer (int64) См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. insertQuorumTimeout	integer (int64) Время ожидания записи для кворума в миллисекундах. Значение по умолчанию: 60000. См. подробное описание в документации ClickHouse. Минимальное значение — 1000.
userSpecs[]. settings. selectSequentialConsistency	boolean (boolean) См. подробное описание в документации ClickHouse.
userSpecs[]. settings. maxReplicaDelayForDistributedQueries	integer (int64) Максимальная задержка реплики в миллисекундах. Если реплика отстает на значение больше установленного, реплика перестает использоваться. Значение по умолчанию: 300000. См. подробное описание в документации ClickHouse. Минимальное значение — 1000.
userSpecs[]. settings. fallbackToStaleReplicasForDistributedQueries	boolean (boolean) См. подробное описание в документации ClickHouse.
userSpecs[]. settings. maxThreads	integer (int64) См. подробное описание в документации ClickHouse. Значение должно быть больше 0.
userSpecs[]. settings. maxBlockSize	integer (int64) См. подробное описание в документации ClickHouse. Значение должно быть больше 0.
userSpecs[]. settings. maxInsertBlockSize	integer (int64) См. подробное описание в документации ClickHouse. Значение должно быть больше 0.
userSpecs[]. settings. maxMemoryUsage	integer (int64) См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. maxMemoryUsageForUser	integer (int64) См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. maxRowsToRead	integer (int64) См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. maxBytesToRead	integer (int64) См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. readOverflowMode	string См. подробное описание в документации ClickHouse.
userSpecs[]. settings. maxRowsToGroupBy	integer (int64) См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. groupByOverflowMode	string См. подробное описание в документации ClickHouse.
userSpecs[]. settings. maxRowsToSort	integer (int64) См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. maxBytesToSort	integer (int64) См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. sortOverflowMode	string См. подробное описание в документации ClickHouse.
userSpecs[]. settings. maxResultRows	integer (int64) См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. maxResultBytes	integer (int64) См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. resultOverflowMode	string См. подробное описание в документации ClickHouse.
userSpecs[]. settings. maxRowsInDistinct	integer (int64) См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. maxBytesInDistinct	integer (int64) См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. distinctOverflowMode	string См. подробное описание в документации ClickHouse.
userSpecs[]. settings. maxRowsToTransfer	integer (int64) См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. maxBytesToTransfer	integer (int64) См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. transferOverflowMode	string См. подробное описание в документации ClickHouse.
userSpecs[]. settings. maxExecutionTime	integer (int64) Максимальное время выполнения запроса в миллисекундах. См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. timeoutOverflowMode	string См. подробное описание в документации ClickHouse.
userSpecs[]. settings. maxColumnsToRead	integer (int64) Максимальное количество столбцов, которые можно прочитать из таблицы в одном запросе. См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. maxTemporaryColumns	integer (int64) Максимальное количество временных столбцов, которые должны храниться в оперативной памяти одновременно при выполнении запроса, включая постоянные столбцы. См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. maxTemporaryNonConstColumns	integer (int64) Максимальное количество временных столбцов, которые должны храниться в оперативной памяти одновременно при выполнении запроса, за исключением постоянных столбцов. См. подробное описание в документации ClickHouse. Минимальное значение — 0.
userSpecs[]. settings. maxQuerySize	integer (int64) Наибольшая часть запроса, которая может быть передана в RAM для разбора с помощью анализатора SQL, в байтах. Значение по умолчанию: 262144. См. подробное описание в документации ClickHouse. Значение должно быть больше 0.
userSpecs[]. settings. maxAstDepth	integer (int64) Максимальная глубина синтаксического дерева запроса. Значение по умолчанию: 1000. См. подробное описание в документации ClickHouse. Значение должно быть больше 0.
userSpecs[]. settings. maxAstElements	integer (int64) Максимальный размер синтаксического дерева запроса в количестве узлов. Значение по умолчанию: 50000. См. подробное описание в документации ClickHouse. Значение должно быть больше 0.
userSpecs[]. settings. maxExpandedAstElements	integer (int64) Максимальный размер синтаксического дерева запроса в количестве узлов после раскрытия псевдонимов и звездочки. Значение по умолчанию: 500000. Значение должно быть больше 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_-]*`.

Ответ

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