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

Метод updateShard

Изменяет указанный шард.

HTTP-запрос

PATCH https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/{clusterId}/shards/{shardName}

Path-параметры

Параметр Описание
clusterId Обязательное поле. Идентификатор кластера ClickHouse, которому принадлежит шард. Чтобы получить идентификатор кластера, используйте запрос list. Максимальная длина строки в символах — 50.
shardName Обязательное поле. Имя шарда, который следует изменить. Чтобы получить имя шарда, используйте запрос listShards. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]*.

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

{
  "updateMask": "string",
  "configSpec": {
    "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"
      },
      "resources": {
        "resourcePresetId": "string",
        "diskSize": "string",
        "diskTypeId": "string"
      },
      "weight": "integer"
    }
  }
}
Поле Описание
updateMask string

Маска, которая указывает, какие атрибуты шарда должны быть изменены.

Имена всех обновляемых полей, разделенные запятыми. Только значения указанных полей будут изменены. Остальные останутся нетронутыми. Если поле указано в параметре updateMask и в запросе не было отправлено значение для этого поля, значение поля будет сброшено на значение по умолчанию. Значение по умолчанию для большинства полей — null или 0.

Если в запросе не передается updateMask, значения всех полей будут обновлены. Для полей, указанных в запросе, будут использованы переданные значения. Значения остальных полей будут сброшены на значения по умолчанию.
configSpec object

Новая конфигурация для указанного шарда.
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.
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.
configSpec.
clickhouse.
config.
dictionaries[].
postgresqlSource.
sslMode		 string

Режим SSL TCP/IP соединения с хостом PostgreSQL. Есть шесть режимов: disable, allow, prefer (используется по умолчанию), require, verify-ca, verify-full. Дополнительные сведения см. в документации PostgreSQL.
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)

Интервал времени для перезагрузки встроенных словарей. См. подробное описание в документации ClickHouse.
configSpec.
clickhouse.
config.
timezone		 string

Часовой пояс сервера, используемый в преобразованиях полей DateTime. Указывается как идентификатор IANA. См. подробное описание в документации ClickHouse.
configSpec.
clickhouse.
resources		 object

Вычислительные ресурсы для шарда.
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.
clickhouse.
weight		 integer (int64)

Относительный вес шарда, который учитывается при записи данных в кластер. Подробнее см. в документации ClickHouse.

Ответ

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.