Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
Yandex Managed Service for ClickHouse
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Информация об имеющихся кластерах
    • Создание кластера
    • Подключение к базе данных
    • Остановка и запуск кластера
    • SQL-запросы в консоли управления
    • Изменение настроек кластера и базы данных
    • Настройка доступа к ObjectStorage
    • Подключение внешних словарей
    • Подключение собственной геобазы
    • Управление моделями машинного обучения
    • Управление схемами формата данных
    • Подключение к DataLens
    • Изменение версии ClickHouse
    • Управление хостами ZooKeeper
    • Управление хостами ClickHouse
    • Управление базами данных
    • Управление пользователями БД
    • Управление резервными копиями
    • Управление шардами
    • Управление группами шардов
    • Просмотр логов кластера
    • Удаление кластера
    • Мониторинг состояния кластера и хостов
  • Практические руководства
    • Все сценарии
    • Добавление данных в БД
    • Шардирование таблиц
    • Использование гибридного хранилища
    • Получение данных из Managed Service for Apache Kafka®
    • Получение данных из RabbitMQ
    • Обмен данными с Yandex Data Proc
    • Настройка Yandex Cloud DNS для доступа к кластеру из других облачных сетей
    • Анализ логов Object Storage при помощи DataLens
    • Настройка Managed Service for ClickHouse для Graphite
    • Сохранение потока данных Yandex Data Streams в Managed Service for ClickHouse
    • Миграция базы данных из Google BigQuery в Managed Service for ClickHouse
    • Поставка данных из Yandex Managed Service for Apache Kafka® с помощью Yandex Data Transfer
  • Концепции
    • Взаимосвязь ресурсов сервиса
    • Классы хостов
      • Действующие классы хостов
      • Архив
        • До 1 июня 2020 года
      • Использование устаревших классов хостов
    • Сеть в Managed Service for ClickHouse
    • Квоты и лимиты
    • Типы дисков
    • Резервные копии
    • Репликация
    • Словари
    • Шардирование
    • Техническое обслуживание
    • Поддерживаемые клиенты
    • Управление памятью в Managed Service for ClickHouse
    • Политика работы с версиями ClickHouse
    • Настройки ClickHouse
  • Управление доступом
  • Правила тарификации
    • Действующие правила
    • Архив
      • До 1 января 2019 года
      • С 1 января до 1 марта 2019 года
      • С 1 марта 2019 года до 1 февраля 2020 года
  • Справочник API
    • Аутентификация в API
    • gRPC (англ.)
      • Overview
      • BackupService
      • ClusterService
      • DatabaseService
      • FormatSchemaService
      • MlModelService
      • ResourcePresetService
      • UserService
      • VersionsService
      • OperationService
    • REST (англ.)
      • Overview
      • Backup
        • Overview
        • get
        • list
      • Cluster
        • Overview
        • addHosts
        • addShard
        • addZookeeper
        • backup
        • create
        • createExternalDictionary
        • createShardGroup
        • delete
        • deleteExternalDictionary
        • deleteHosts
        • deleteShard
        • deleteShardGroup
        • get
        • getShard
        • getShardGroup
        • list
        • listBackups
        • listExternalDictionaries
        • listHosts
        • listLogs
        • listOperations
        • listShardGroups
        • listShards
        • move
        • rescheduleMaintenance
        • restore
        • start
        • stop
        • streamLogs
        • update
        • updateExternalDictionary
        • updateHosts
        • updateShard
        • updateShardGroup
      • Database
        • Overview
        • create
        • delete
        • get
        • list
      • FormatSchema
        • Overview
        • create
        • delete
        • get
        • list
        • update
      • MlModel
        • Overview
        • create
        • delete
        • get
        • list
        • update
      • ResourcePreset
        • Overview
        • get
        • list
      • User
        • Overview
        • create
        • delete
        • get
        • grantPermission
        • list
        • revokePermission
        • update
      • Versions
        • Overview
        • list
      • Operation
        • Overview
        • get
  • История изменений
  • Вопросы и ответы
    • Общие вопросы
    • Вопросы о ClickHouse
    • Подключение
    • Изменение кластера
    • Настройки параметров кластера
    • Перемещение и восстановление кластера
    • Мониторинг и логи
    • Все вопросы на одной странице
  1. Справочник API
  2. REST (англ.)
  3. Cluster
  4. list

Managed Service for ClickHouse API, REST: Cluster.list

Статья создана
Yandex Cloud
,
улучшена
amatol
  • HTTP request
  • Query parameters
  • Response

Retrieves a list of ClickHouse clusters that belong
to the specified folder.

HTTP request

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

Query parameters

Parameter Description
folderId

Required. ID of the folder to list ClickHouse clusters in. To get the folder ID, use a list request.

The maximum string length in characters is 50.

pageSize

The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

The maximum value is 1000.

pageToken

Page token. To get the next page of results, set pageToken to the nextPageToken returned by the previous list request.

The maximum string length in characters is 100.

filter

A filter expression that filters resources listed in the response. The expression must specify:

  1. The field name. Currently you can only use filtering with the Cluster.name field.
  2. An = operator.
  3. The value in double quotes ("). Must be 1-63 characters long and match the regular expression [a-zA-Z0-9_-]+.

The maximum string length in characters is 1000.

Response

HTTP Code: 200 - OK

{
  "clusters": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "environment": "string",
      "monitoring": [
        {
          "name": "string",
          "description": "string",
          "link": "string"
        }
      ],
      "config": {
        "version": "string",
        "clickhouse": {
          "config": {
            "effectiveConfig": {
              "logLevel": "string",
              "mergeTree": {
                "replicatedDeduplicationWindow": "integer",
                "replicatedDeduplicationWindowSeconds": "integer",
                "partsToDelayInsert": "integer",
                "partsToThrowInsert": "integer",
                "inactivePartsToDelayInsert": "integer",
                "inactivePartsToThrowInsert": "integer",
                "maxReplicatedMergesInQueue": "integer",
                "numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "integer",
                "maxBytesToMergeAtMinSpaceInPool": "integer",
                "maxBytesToMergeAtMaxSpaceInPool": "integer",
                "minBytesForWidePart": "integer",
                "minRowsForWidePart": "integer",
                "ttlOnlyDropParts": true,
                "allowRemoteFsZeroCopyReplication": true
              },
              "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"
                  },

                  // `clusters[].config.clickhouse.config.effectiveConfig.dictionaries[]` includes only one of the fields `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
                  "fixedLifetime": "string",
                  "lifetimeRange": {
                    "min": "string",
                    "max": "string"
                  },
                  // end of the list of possible fields`clusters[].config.clickhouse.config.effectiveConfig.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"
                        }
                      ]
                    }
                  ]
                }
              ],
              "kafka": {
                "securityProtocol": "string",
                "saslMechanism": "string",
                "saslUsername": "string",
                "saslPassword": "string"
              },
              "kafkaTopics": [
                {
                  "name": "string",
                  "settings": {
                    "securityProtocol": "string",
                    "saslMechanism": "string",
                    "saslUsername": "string",
                    "saslPassword": "string"
                  }
                }
              ],
              "rabbitmq": {
                "username": "string",
                "password": "string",
                "vhost": "string"
              },
              "maxConnections": "integer",
              "maxConcurrentQueries": "integer",
              "keepAliveTimeout": "integer",
              "uncompressedCacheSize": "integer",
              "markCacheSize": "integer",
              "maxTableSizeToDrop": "integer",
              "maxPartitionSizeToDrop": "integer",
              "builtinDictionariesReloadInterval": "integer",
              "timezone": "string",
              "geobaseUri": "string",
              "queryLogRetentionSize": "integer",
              "queryLogRetentionTime": "integer",
              "queryThreadLogEnabled": true,
              "queryThreadLogRetentionSize": "integer",
              "queryThreadLogRetentionTime": "integer",
              "partLogRetentionSize": "integer",
              "partLogRetentionTime": "integer",
              "metricLogEnabled": true,
              "metricLogRetentionSize": "integer",
              "metricLogRetentionTime": "integer",
              "traceLogEnabled": true,
              "traceLogRetentionSize": "integer",
              "traceLogRetentionTime": "integer",
              "textLogEnabled": true,
              "textLogRetentionSize": "integer",
              "textLogRetentionTime": "integer",
              "textLogLevel": "string",
              "opentelemetrySpanLogEnabled": true,
              "backgroundPoolSize": "integer",
              "backgroundSchedulePoolSize": "integer",
              "backgroundFetchesPoolSize": "integer",
              "backgroundMovePoolSize": "integer",
              "backgroundDistributedSchedulePoolSize": "integer",
              "backgroundBufferFlushSchedulePoolSize": "integer",
              "defaultDatabase": "string",
              "totalMemoryProfilerStep": "integer",
              "totalMemoryTrackerSampleProbability": "number"
            },
            "userConfig": {
              "logLevel": "string",
              "mergeTree": {
                "replicatedDeduplicationWindow": "integer",
                "replicatedDeduplicationWindowSeconds": "integer",
                "partsToDelayInsert": "integer",
                "partsToThrowInsert": "integer",
                "inactivePartsToDelayInsert": "integer",
                "inactivePartsToThrowInsert": "integer",
                "maxReplicatedMergesInQueue": "integer",
                "numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "integer",
                "maxBytesToMergeAtMinSpaceInPool": "integer",
                "maxBytesToMergeAtMaxSpaceInPool": "integer",
                "minBytesForWidePart": "integer",
                "minRowsForWidePart": "integer",
                "ttlOnlyDropParts": true,
                "allowRemoteFsZeroCopyReplication": true
              },
              "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"
                  },

                  // `clusters[].config.clickhouse.config.userConfig.dictionaries[]` includes only one of the fields `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
                  "fixedLifetime": "string",
                  "lifetimeRange": {
                    "min": "string",
                    "max": "string"
                  },
                  // end of the list of possible fields`clusters[].config.clickhouse.config.userConfig.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"
                        }
                      ]
                    }
                  ]
                }
              ],
              "kafka": {
                "securityProtocol": "string",
                "saslMechanism": "string",
                "saslUsername": "string",
                "saslPassword": "string"
              },
              "kafkaTopics": [
                {
                  "name": "string",
                  "settings": {
                    "securityProtocol": "string",
                    "saslMechanism": "string",
                    "saslUsername": "string",
                    "saslPassword": "string"
                  }
                }
              ],
              "rabbitmq": {
                "username": "string",
                "password": "string",
                "vhost": "string"
              },
              "maxConnections": "integer",
              "maxConcurrentQueries": "integer",
              "keepAliveTimeout": "integer",
              "uncompressedCacheSize": "integer",
              "markCacheSize": "integer",
              "maxTableSizeToDrop": "integer",
              "maxPartitionSizeToDrop": "integer",
              "builtinDictionariesReloadInterval": "integer",
              "timezone": "string",
              "geobaseUri": "string",
              "queryLogRetentionSize": "integer",
              "queryLogRetentionTime": "integer",
              "queryThreadLogEnabled": true,
              "queryThreadLogRetentionSize": "integer",
              "queryThreadLogRetentionTime": "integer",
              "partLogRetentionSize": "integer",
              "partLogRetentionTime": "integer",
              "metricLogEnabled": true,
              "metricLogRetentionSize": "integer",
              "metricLogRetentionTime": "integer",
              "traceLogEnabled": true,
              "traceLogRetentionSize": "integer",
              "traceLogRetentionTime": "integer",
              "textLogEnabled": true,
              "textLogRetentionSize": "integer",
              "textLogRetentionTime": "integer",
              "textLogLevel": "string",
              "opentelemetrySpanLogEnabled": true,
              "backgroundPoolSize": "integer",
              "backgroundSchedulePoolSize": "integer",
              "backgroundFetchesPoolSize": "integer",
              "backgroundMovePoolSize": "integer",
              "backgroundDistributedSchedulePoolSize": "integer",
              "backgroundBufferFlushSchedulePoolSize": "integer",
              "defaultDatabase": "string",
              "totalMemoryProfilerStep": "integer",
              "totalMemoryTrackerSampleProbability": "number"
            },
            "defaultConfig": {
              "logLevel": "string",
              "mergeTree": {
                "replicatedDeduplicationWindow": "integer",
                "replicatedDeduplicationWindowSeconds": "integer",
                "partsToDelayInsert": "integer",
                "partsToThrowInsert": "integer",
                "inactivePartsToDelayInsert": "integer",
                "inactivePartsToThrowInsert": "integer",
                "maxReplicatedMergesInQueue": "integer",
                "numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "integer",
                "maxBytesToMergeAtMinSpaceInPool": "integer",
                "maxBytesToMergeAtMaxSpaceInPool": "integer",
                "minBytesForWidePart": "integer",
                "minRowsForWidePart": "integer",
                "ttlOnlyDropParts": true,
                "allowRemoteFsZeroCopyReplication": true
              },
              "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"
                  },

                  // `clusters[].config.clickhouse.config.defaultConfig.dictionaries[]` includes only one of the fields `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
                  "fixedLifetime": "string",
                  "lifetimeRange": {
                    "min": "string",
                    "max": "string"
                  },
                  // end of the list of possible fields`clusters[].config.clickhouse.config.defaultConfig.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"
                        }
                      ]
                    }
                  ]
                }
              ],
              "kafka": {
                "securityProtocol": "string",
                "saslMechanism": "string",
                "saslUsername": "string",
                "saslPassword": "string"
              },
              "kafkaTopics": [
                {
                  "name": "string",
                  "settings": {
                    "securityProtocol": "string",
                    "saslMechanism": "string",
                    "saslUsername": "string",
                    "saslPassword": "string"
                  }
                }
              ],
              "rabbitmq": {
                "username": "string",
                "password": "string",
                "vhost": "string"
              },
              "maxConnections": "integer",
              "maxConcurrentQueries": "integer",
              "keepAliveTimeout": "integer",
              "uncompressedCacheSize": "integer",
              "markCacheSize": "integer",
              "maxTableSizeToDrop": "integer",
              "maxPartitionSizeToDrop": "integer",
              "builtinDictionariesReloadInterval": "integer",
              "timezone": "string",
              "geobaseUri": "string",
              "queryLogRetentionSize": "integer",
              "queryLogRetentionTime": "integer",
              "queryThreadLogEnabled": true,
              "queryThreadLogRetentionSize": "integer",
              "queryThreadLogRetentionTime": "integer",
              "partLogRetentionSize": "integer",
              "partLogRetentionTime": "integer",
              "metricLogEnabled": true,
              "metricLogRetentionSize": "integer",
              "metricLogRetentionTime": "integer",
              "traceLogEnabled": true,
              "traceLogRetentionSize": "integer",
              "traceLogRetentionTime": "integer",
              "textLogEnabled": true,
              "textLogRetentionSize": "integer",
              "textLogRetentionTime": "integer",
              "textLogLevel": "string",
              "opentelemetrySpanLogEnabled": true,
              "backgroundPoolSize": "integer",
              "backgroundSchedulePoolSize": "integer",
              "backgroundFetchesPoolSize": "integer",
              "backgroundMovePoolSize": "integer",
              "backgroundDistributedSchedulePoolSize": "integer",
              "backgroundBufferFlushSchedulePoolSize": "integer",
              "defaultDatabase": "string",
              "totalMemoryProfilerStep": "integer",
              "totalMemoryTrackerSampleProbability": "number"
            }
          },
          "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,
          "dataTransfer": true,
          "yandexQuery": true
        },
        "cloudStorage": {
          "enabled": true,
          "moveFactor": "number",
          "dataCacheEnabled": true,
          "dataCacheMaxSize": "integer"
        },
        "sqlDatabaseManagement": true,
        "sqlUserManagement": true,
        "embeddedKeeper": true
      },
      "networkId": "string",
      "health": "string",
      "status": "string",
      "serviceAccountId": "string",
      "maintenanceWindow": {

        // `clusters[].maintenanceWindow` includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
        "anytime": {},
        "weeklyMaintenanceWindow": {
          "day": "string",
          "hour": "string"
        },
        // end of the list of possible fields`clusters[].maintenanceWindow`

      },
      "plannedOperation": {
        "info": "string",
        "delayedUntil": "string"
      },
      "securityGroupIds": [
        "string"
      ],
      "deletionProtection": true
    }
  ],
  "nextPageToken": "string"
}
Field Description
clusters[] object

List of ClickHouse Cluster resources.

clusters[].
id
string

ID of the ClickHouse cluster. This ID is assigned by MDB at creation time.

clusters[].
folderId
string

ID of the folder that the ClickHouse cluster belongs to.

clusters[].
createdAt
string (date-time)

Creation timestamp in RFC3339 text format.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

clusters[].
name
string

Name of the ClickHouse cluster. The name is unique within the folder. 1-63 characters long.

clusters[].
description
string

Description of the ClickHouse cluster. 0-256 characters long.

clusters[].
labels
object

Custom labels for the ClickHouse cluster as key:value pairs. Maximum 64 per resource.

clusters[].
environment
string

Deployment environment of the ClickHouse cluster.

  • PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.
  • PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
clusters[].
monitoring[]
object

Description of monitoring systems relevant to the ClickHouse cluster.

clusters[].
monitoring[].
name
string

Name of the monitoring system.

clusters[].
monitoring[].
description
string

Description of the monitoring system.

clusters[].
monitoring[].
link
string

Link to the monitoring system charts for the ClickHouse cluster.

clusters[].
config
object

Configuration of the ClickHouse cluster.

clusters[].
config.
version
string

Version of the ClickHouse server software.

clusters[].
config.
clickhouse
object

Configuration and resource allocation for ClickHouse hosts.

clusters[].
config.
clickhouse.
config
object

Configuration settings of a ClickHouse server.

clusters[].
config.
clickhouse.
config.
effectiveConfig
object

Required. Effective settings for a ClickHouse cluster (a combination of settings defined in userConfig and defaultConfig).

ClickHouse configuration options. Detailed description for each set of options is available in ClickHouse documentation.

Any options not listed here are not supported.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
logLevel
string

Logging level for the ClickHouse cluster. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree
object

Settings for the MergeTree engine. See description in ClickHouse documentation.

Options specific to the MergeTree table engine.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
replicatedDeduplicationWindow
integer (int64)

Number of blocks of hashes to keep in ZooKeeper.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
replicatedDeduplicationWindowSeconds
integer (int64)

Period of time to keep blocks of hashes for.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
partsToDelayInsert
integer (int64)

If table contains at least that many active parts in single partition, artificially slow down insert into table.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
partsToThrowInsert
integer (int64)

If more than this number active parts in single partition, throw 'Too many parts ...' exception.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
inactivePartsToDelayInsert
integer (int64)
clusters[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
inactivePartsToThrowInsert
integer (int64)
clusters[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
maxReplicatedMergesInQueue
integer (int64)

How many tasks of merging and mutating parts are allowed simultaneously in ReplicatedMergeTree queue.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge
integer (int64)

If there is less than specified number of free entries in background pool (or replicated queue), start to lower maximum size of merge to process.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
maxBytesToMergeAtMinSpaceInPool
integer (int64)

Maximum in total size of parts to merge, when there are minimum free threads in background pool (or entries in replication queue).

clusters[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
maxBytesToMergeAtMaxSpaceInPool
integer (int64)
clusters[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
minBytesForWidePart
integer (int64)

Minimum number of bytes in a data part that can be stored in Wide format.

More info see in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
minRowsForWidePart
integer (int64)

Minimum number of rows in a data part that can be stored in Wide format.

More info see in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
ttlOnlyDropParts
boolean (boolean)

Enables or disables complete dropping of data parts where all rows are expired in MergeTree tables.

More info see in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
mergeTree.
allowRemoteFsZeroCopyReplication
boolean (boolean)
clusters[].
config.
clickhouse.
config.
effectiveConfig.
compression[]
object

Compression settings for the ClickHouse cluster. See in-depth description in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
compression[].
method
string

Compression method to use for the specified combination of minPartSize and minPartSizeRatio.

  • LZ4: LZ4 compression algorithm.
  • ZSTD: Zstandard compression algorithm.
clusters[].
config.
clickhouse.
config.
effectiveConfig.
compression[].
minPartSize
string (int64)

Minimum size of a part of a table.

The minimum value is 1.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
compression[].
minPartSizeRatio
number (double)

Minimum ratio of a part relative to the size of all the data in the table.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[]
object

Configuration of external dictionaries to be used by the ClickHouse cluster. See in-depth description in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
name
string

Required. Name of the external dictionary.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure
object
Required. Set of attributes for the external dictionary. For in-depth description, see ClickHouse documentation.
clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
id
object

Single numeric key column for the dictionary.

Numeric key.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
id.
name
string

Required. Name of the numeric key.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
key
object

Composite key for the dictionary, containing of one or more key columns. For details, see ClickHouse documentation.

Complex key.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
key.
attributes[]
object

Required. Attributes of a complex key.

Must contain at least one element.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
key.
attributes[].
name
string

Required. Name of the column.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
key.
attributes[].
type
string

Required. Type of the column.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
key.
attributes[].
nullValue
string

Default value for an element without data (for example, an empty string).

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
key.
attributes[].
expression
string

Expression, describing the attribute, if applicable.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
key.
attributes[].
hierarchical
boolean (boolean)

Indication of hierarchy support. Default value: false.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
key.
attributes[].
injective
boolean (boolean)

Indication of injective mapping "id -> attribute". Default value: false.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMin
object

Field holding the beginning of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMin.
name
string

Required. Name of the column.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMin.
type
string

Required. Type of the column.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMin.
nullValue
string

Default value for an element without data (for example, an empty string).

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMin.
expression
string

Expression, describing the attribute, if applicable.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMin.
hierarchical
boolean (boolean)

Indication of hierarchy support. Default value: false.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMin.
injective
boolean (boolean)

Indication of injective mapping "id -> attribute". Default value: false.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMax
object

Field holding the end of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMax.
name
string

Required. Name of the column.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMax.
type
string

Required. Type of the column.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMax.
nullValue
string

Default value for an element without data (for example, an empty string).

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMax.
expression
string

Expression, describing the attribute, if applicable.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMax.
hierarchical
boolean (boolean)

Indication of hierarchy support. Default value: false.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
rangeMax.
injective
boolean (boolean)

Indication of injective mapping "id -> attribute". Default value: false.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
attributes[]
object

Required. Description of the fields available for database queries. For details, see ClickHouse documentation.

Must contain at least one element.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
attributes[].
name
string

Required. Name of the column.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
attributes[].
type
string

Required. Type of the column.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
attributes[].
nullValue
string

Default value for an element without data (for example, an empty string).

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
attributes[].
expression
string

Expression, describing the attribute, if applicable.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
attributes[].
hierarchical
boolean (boolean)

Indication of hierarchy support. Default value: false.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
structure.
attributes[].
injective
boolean (boolean)

Indication of injective mapping "id -> attribute". Default value: false.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
layout
object
Required. Layout for storing the dictionary in memory. For in-depth description, see ClickHouse documentation.
clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
layout.
type
string

Required. Layout type for an external dictionary.

  • FLAT: The entire dictionary is stored in memory in the form of flat arrays. Available for all dictionary sources.
  • HASHED: The entire dictionary is stored in memory in the form of a hash table. Available for all dictionary sources.
  • COMPLEX_KEY_HASHED: Similar to HASHED, to be used with composite keys. Available for all dictionary sources.
  • RANGE_HASHED: The entire dictionary is stored in memory in the form of a hash table, with an ordered array of ranges and their corresponding values. Available for all dictionary sources.
  • CACHE: The dictionary is stored in a cache with a set number of cells. Available for MySQL, ClickHouse and HTTP dictionary sources.
  • COMPLEX_KEY_CACHE: Similar to CACHE, to be used with composite keys. Available for MySQL, ClickHouse and HTTP dictionary sources.
clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
layout.
sizeInCells
string (int64)

Number of cells in the cache. Rounded up to a power of two. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
fixedLifetime
string (int64)
clusters[].config.clickhouse.config.effectiveConfig.dictionaries[] includes only one of the fields fixedLifetime, lifetimeRange

Fixed interval between dictionary updates.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
lifetimeRange
object
Range of intervals between dictionary updates for ClickHouse to choose from.
clusters[].config.clickhouse.config.effectiveConfig.dictionaries[] includes only one of the fields fixedLifetime, lifetimeRange
clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
lifetimeRange.
min
string (int64)

Minimum dictionary lifetime.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
lifetimeRange.
max
string (int64)

Maximum dictionary lifetime.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
httpSource
object
HTTP source for the dictionary.
clusters[].config.clickhouse.config.effectiveConfig.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
httpSource.
url
string

Required. URL of the source dictionary available over HTTP.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
httpSource.
format
string

Required. The data format. Valid values are all formats supported by ClickHouse SQL dialect.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource
object
MySQL source for the dictionary.
clusters[].config.clickhouse.config.effectiveConfig.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
db
string

Required. Name of the MySQL database to connect to.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
table
string

Required. Name of the database table to use as a ClickHouse dictionary.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
port
string (int64)

Default port to use when connecting to a replica of the dictionary source.

Acceptable values are 0 to 65535, inclusive.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
user
string

Name of the default user for replicas of the dictionary source.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
password
string

Password of the default user for replicas of the dictionary source.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
replicas[]
object

Required. List of MySQL replicas of the database used as dictionary source.

Must contain at least one element.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
replicas[].
host
string

Required. MySQL host of the replica.

The maximum string length in characters is 253.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
replicas[].
priority
string (int64)

Required. The priority of the replica that ClickHouse takes into account when connecting. Replica with the highest priority should have this field set to the lowest number.

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
replicas[].
port
string (int64)

Port to use when connecting to the replica. If a port is not specified for a replica, ClickHouse uses the port specified for the source.

Acceptable values are 0 to 65535, inclusive.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
replicas[].
user
string

Name of the MySQL database user.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
replicas[].
password
string

Password of the MySQL database user.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
where
string

Selection criteria for the data in the specified MySQL table.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mysqlSource.
invalidateQuery
string

Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
clickhouseSource
object
ClickHouse source for the dictionary.
clusters[].config.clickhouse.config.effectiveConfig.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
clickhouseSource.
db
string

Required. Name of the ClickHouse database.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
clickhouseSource.
table
string

Required. Name of the table in the specified database to be used as the dictionary source.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
clickhouseSource.
host
string

Required. ClickHouse host of the specified database.

The maximum string length in characters is 253.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
clickhouseSource.
port
string (int64)

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
clickhouseSource.
user
string

Required. Name of the ClickHouse database user.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
clickhouseSource.
password
string

Password of the ClickHouse database user.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
clickhouseSource.
where
string

Selection criteria for the data in the specified ClickHouse table.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mongodbSource
object
MongoDB source for the dictionary.
clusters[].config.clickhouse.config.effectiveConfig.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mongodbSource.
db
string

Required. Name of the MongoDB database.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mongodbSource.
collection
string

Required. Name of the collection in the specified database to be used as the dictionary source.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mongodbSource.
host
string

Required. MongoDB host of the specified database.

The maximum string length in characters is 253.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mongodbSource.
port
string (int64)

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mongodbSource.
user
string

Required. Name of the MongoDB database user.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
mongodbSource.
password
string

Password of the MongoDB database user.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
postgresqlSource
object
PostgreSQL source for the dictionary.
clusters[].config.clickhouse.config.effectiveConfig.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
postgresqlSource.
db
string

Required. Name of the PostrgreSQL database.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
postgresqlSource.
table
string

Required. Name of the table in the specified database to be used as the dictionary source.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
postgresqlSource.
hosts[]
string

Required. Name of the PostrgreSQL host

Must contain at least one element.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
postgresqlSource.
port
string (int64)

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
postgresqlSource.
user
string

Required. Name of the PostrgreSQL database user.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
postgresqlSource.
password
string

Password of the PostrgreSQL database user.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
postgresqlSource.
invalidateQuery
string

Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
dictionaries[].
postgresqlSource.
sslMode
string

Mode of SSL TCP/IP connection to the PostgreSQL host. For more details, see PostgreSQL documentation.

  • DISABLE: Only try a non-SSL connection.
  • ALLOW: First try a non-SSL connection; if that fails, try an SSL connection.
  • PREFER: First try an SSL connection; if that fails, try a non-SSL connection.
  • VERIFY_CA: Only try an SSL connection, and verify that the server certificate is issued by a trusted certificate authority (CA).
  • VERIFY_FULL: Only try an SSL connection, verify that the server certificate is issued by a trusted CA and that the requested server host name matches that in the certificate.
clusters[].
config.
clickhouse.
config.
effectiveConfig.
graphiteRollup[]
object

Settings for thinning Graphite data. See in-depth description in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
graphiteRollup[].
name
string

Required. Name for the specified combination of settings for Graphite rollup.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
graphiteRollup[].
patterns[]
object

Required. Pattern to use for the rollup.

Must contain at least one element.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
graphiteRollup[].
patterns[].
regexp
string

Pattern for metric names.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
graphiteRollup[].
patterns[].
function
string

Required. Name of the aggregating function to apply to data of the age specified in retention.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
graphiteRollup[].
patterns[].
retention[]
object

Required. Age of data to use for thinning.

Must contain at least one element.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
graphiteRollup[].
patterns[].
retention[].
age
string (int64)

Minimum age of the data in seconds.

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
graphiteRollup[].
patterns[].
retention[].
precision
string (int64)

Precision of determining the age of the data, in seconds.

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
kafka
object
clusters[].
config.
clickhouse.
config.
effectiveConfig.
kafka.
securityProtocol
string
clusters[].
config.
clickhouse.
config.
effectiveConfig.
kafka.
saslMechanism
string
clusters[].
config.
clickhouse.
config.
effectiveConfig.
kafka.
saslUsername
string
clusters[].
config.
clickhouse.
config.
effectiveConfig.
kafka.
saslPassword
string
clusters[].
config.
clickhouse.
config.
effectiveConfig.
kafkaTopics[]
object
clusters[].
config.
clickhouse.
config.
effectiveConfig.
kafkaTopics[].
name
string

Required.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
kafkaTopics[].
settings
object

Required.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
kafkaTopics[].
settings.
securityProtocol
string
clusters[].
config.
clickhouse.
config.
effectiveConfig.
kafkaTopics[].
settings.
saslMechanism
string
clusters[].
config.
clickhouse.
config.
effectiveConfig.
kafkaTopics[].
settings.
saslUsername
string
clusters[].
config.
clickhouse.
config.
effectiveConfig.
kafkaTopics[].
settings.
saslPassword
string
clusters[].
config.
clickhouse.
config.
effectiveConfig.
rabbitmq
object
clusters[].
config.
clickhouse.
config.
effectiveConfig.
rabbitmq.
username
string

RabbitMQ username

clusters[].
config.
clickhouse.
config.
effectiveConfig.
rabbitmq.
password
string

RabbitMQ password

clusters[].
config.
clickhouse.
config.
effectiveConfig.
rabbitmq.
vhost
string

RabbitMQ virtual host

clusters[].
config.
clickhouse.
config.
effectiveConfig.
maxConnections
integer (int64)

Maximum number of inbound connections.

The minimum value is 10.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
maxConcurrentQueries
integer (int64)

Maximum number of simultaneously processed requests.

The minimum value is 10.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
keepAliveTimeout
integer (int64)

Number of milliseconds that ClickHouse waits for incoming requests before closing the connection.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
uncompressedCacheSize
integer (int64)

Cache size (in bytes) for uncompressed data used by MergeTree tables.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
markCacheSize
integer (int64)

Approximate size (in bytes) of the cache of "marks" used by MergeTree tables.

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
maxTableSizeToDrop
integer (int64)

Maximum size of the table that can be deleted using a DROP query.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
maxPartitionSizeToDrop
integer (int64)

Maximum size of the partition that can be deleted using a DROP query.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
builtinDictionariesReloadInterval
integer (int64)

The setting is deprecated and has no effect.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
timezone
string

The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
geobaseUri
string

Address of the archive with the user geobase in Object Storage.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
queryLogRetentionSize
integer (int64)

The maximum size that query_log can grow to before old data will be removed. If set to 0, automatic removal of query_log data based on size is disabled.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
queryLogRetentionTime
integer (int64)

The maximum time that query_log records will be retained before removal. If set to 0, automatic removal of query_log data based on time is disabled.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
queryThreadLogEnabled
boolean (boolean)

Whether query_thread_log system table is enabled.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
queryThreadLogRetentionSize
integer (int64)

The maximum size that query_thread_log can grow to before old data will be removed. If set to 0, automatic removal of query_thread_log data based on size is disabled.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
queryThreadLogRetentionTime
integer (int64)

The maximum time that query_thread_log records will be retained before removal. If set to 0, automatic removal of query_thread_log data based on time is disabled.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
partLogRetentionSize
integer (int64)

The maximum size that part_log can grow to before old data will be removed. If set to 0, automatic removal of part_log data based on size is disabled.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
partLogRetentionTime
integer (int64)

The maximum time that part_log records will be retained before removal. If set to 0, automatic removal of part_log data based on time is disabled.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
metricLogEnabled
boolean (boolean)

Whether metric_log system table is enabled.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
metricLogRetentionSize
integer (int64)

The maximum size that metric_log can grow to before old data will be removed. If set to 0, automatic removal of metric_log data based on size is disabled.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
metricLogRetentionTime
integer (int64)

The maximum time that metric_log records will be retained before removal. If set to 0, automatic removal of metric_log data based on time is disabled.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
traceLogEnabled
boolean (boolean)

Whether trace_log system table is enabled.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
traceLogRetentionSize
integer (int64)

The maximum size that trace_log can grow to before old data will be removed. If set to 0, automatic removal of trace_log data based on size is disabled.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
traceLogRetentionTime
integer (int64)

The maximum time that trace_log records will be retained before removal. If set to 0, automatic removal of trace_log data based on time is disabled.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
textLogEnabled
boolean (boolean)

Whether text_log system table is enabled.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
textLogRetentionSize
integer (int64)

The maximum size that text_log can grow to before old data will be removed. If set to 0, automatic removal of text_log data based on size is disabled.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
textLogRetentionTime
integer (int64)

The maximum time that text_log records will be retained before removal. If set to 0, automatic removal of text_log data based on time is disabled.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
textLogLevel
string

Logging level for text_log system table. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
opentelemetrySpanLogEnabled
boolean (boolean)
clusters[].
config.
clickhouse.
config.
effectiveConfig.
backgroundPoolSize
integer (int64)

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
backgroundSchedulePoolSize
integer (int64)

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
backgroundFetchesPoolSize
integer (int64)

Sets the number of threads performing background fetches for tables with ReplicatedMergeTree engines. Default value: 8.

More info see in ClickHouse documentation.

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
backgroundMovePoolSize
integer (int64)

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
backgroundDistributedSchedulePoolSize
integer (int64)

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
backgroundBufferFlushSchedulePoolSize
integer (int64)

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
defaultDatabase
string

The default database.

To get a list of cluster databases, see Yandex Managed ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
totalMemoryProfilerStep
integer (int64)

Sets the memory size (in bytes) for a stack trace at every peak allocation step. Default value: 4194304.

More info see in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
effectiveConfig.
totalMemoryTrackerSampleProbability
number (double)
clusters[].
config.
clickhouse.
config.
userConfig
object

User-defined settings for a ClickHouse cluster.

ClickHouse configuration options. Detailed description for each set of options is available in ClickHouse documentation.

Any options not listed here are not supported.

clusters[].
config.
clickhouse.
config.
userConfig.
logLevel
string

Logging level for the ClickHouse cluster. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.

clusters[].
config.
clickhouse.
config.
userConfig.
mergeTree
object

Settings for the MergeTree engine. See description in ClickHouse documentation.

Options specific to the MergeTree table engine.

clusters[].
config.
clickhouse.
config.
userConfig.
mergeTree.
replicatedDeduplicationWindow
integer (int64)

Number of blocks of hashes to keep in ZooKeeper.

clusters[].
config.
clickhouse.
config.
userConfig.
mergeTree.
replicatedDeduplicationWindowSeconds
integer (int64)

Period of time to keep blocks of hashes for.

clusters[].
config.
clickhouse.
config.
userConfig.
mergeTree.
partsToDelayInsert
integer (int64)

If table contains at least that many active parts in single partition, artificially slow down insert into table.

clusters[].
config.
clickhouse.
config.
userConfig.
mergeTree.
partsToThrowInsert
integer (int64)

If more than this number active parts in single partition, throw 'Too many parts ...' exception.

clusters[].
config.
clickhouse.
config.
userConfig.
mergeTree.
inactivePartsToDelayInsert
integer (int64)
clusters[].
config.
clickhouse.
config.
userConfig.
mergeTree.
inactivePartsToThrowInsert
integer (int64)
clusters[].
config.
clickhouse.
config.
userConfig.
mergeTree.
maxReplicatedMergesInQueue
integer (int64)

How many tasks of merging and mutating parts are allowed simultaneously in ReplicatedMergeTree queue.

clusters[].
config.
clickhouse.
config.
userConfig.
mergeTree.
numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge
integer (int64)

If there is less than specified number of free entries in background pool (or replicated queue), start to lower maximum size of merge to process.

clusters[].
config.
clickhouse.
config.
userConfig.
mergeTree.
maxBytesToMergeAtMinSpaceInPool
integer (int64)

Maximum in total size of parts to merge, when there are minimum free threads in background pool (or entries in replication queue).

clusters[].
config.
clickhouse.
config.
userConfig.
mergeTree.
maxBytesToMergeAtMaxSpaceInPool
integer (int64)
clusters[].
config.
clickhouse.
config.
userConfig.
mergeTree.
minBytesForWidePart
integer (int64)

Minimum number of bytes in a data part that can be stored in Wide format.

More info see in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
userConfig.
mergeTree.
minRowsForWidePart
integer (int64)

Minimum number of rows in a data part that can be stored in Wide format.

More info see in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
userConfig.
mergeTree.
ttlOnlyDropParts
boolean (boolean)

Enables or disables complete dropping of data parts where all rows are expired in MergeTree tables.

More info see in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
userConfig.
mergeTree.
allowRemoteFsZeroCopyReplication
boolean (boolean)
clusters[].
config.
clickhouse.
config.
userConfig.
compression[]
object

Compression settings for the ClickHouse cluster. See in-depth description in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
userConfig.
compression[].
method
string

Compression method to use for the specified combination of minPartSize and minPartSizeRatio.

  • LZ4: LZ4 compression algorithm.
  • ZSTD: Zstandard compression algorithm.
clusters[].
config.
clickhouse.
config.
userConfig.
compression[].
minPartSize
string (int64)

Minimum size of a part of a table.

The minimum value is 1.

clusters[].
config.
clickhouse.
config.
userConfig.
compression[].
minPartSizeRatio
number (double)

Minimum ratio of a part relative to the size of all the data in the table.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[]
object

Configuration of external dictionaries to be used by the ClickHouse cluster. See in-depth description in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
name
string

Required. Name of the external dictionary.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure
object
Required. Set of attributes for the external dictionary. For in-depth description, see ClickHouse documentation.
clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
id
object

Single numeric key column for the dictionary.

Numeric key.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
id.
name
string

Required. Name of the numeric key.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
key
object

Composite key for the dictionary, containing of one or more key columns. For details, see ClickHouse documentation.

Complex key.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
key.
attributes[]
object

Required. Attributes of a complex key.

Must contain at least one element.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
key.
attributes[].
name
string

Required. Name of the column.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
key.
attributes[].
type
string

Required. Type of the column.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
key.
attributes[].
nullValue
string

Default value for an element without data (for example, an empty string).

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
key.
attributes[].
expression
string

Expression, describing the attribute, if applicable.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
key.
attributes[].
hierarchical
boolean (boolean)

Indication of hierarchy support. Default value: false.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
key.
attributes[].
injective
boolean (boolean)

Indication of injective mapping "id -> attribute". Default value: false.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMin
object

Field holding the beginning of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMin.
name
string

Required. Name of the column.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMin.
type
string

Required. Type of the column.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMin.
nullValue
string

Default value for an element without data (for example, an empty string).

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMin.
expression
string

Expression, describing the attribute, if applicable.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMin.
hierarchical
boolean (boolean)

Indication of hierarchy support. Default value: false.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMin.
injective
boolean (boolean)

Indication of injective mapping "id -> attribute". Default value: false.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMax
object

Field holding the end of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMax.
name
string

Required. Name of the column.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMax.
type
string

Required. Type of the column.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMax.
nullValue
string

Default value for an element without data (for example, an empty string).

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMax.
expression
string

Expression, describing the attribute, if applicable.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMax.
hierarchical
boolean (boolean)

Indication of hierarchy support. Default value: false.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
rangeMax.
injective
boolean (boolean)

Indication of injective mapping "id -> attribute". Default value: false.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
attributes[]
object

Required. Description of the fields available for database queries. For details, see ClickHouse documentation.

Must contain at least one element.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
attributes[].
name
string

Required. Name of the column.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
attributes[].
type
string

Required. Type of the column.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
attributes[].
nullValue
string

Default value for an element without data (for example, an empty string).

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
attributes[].
expression
string

Expression, describing the attribute, if applicable.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
attributes[].
hierarchical
boolean (boolean)

Indication of hierarchy support. Default value: false.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
structure.
attributes[].
injective
boolean (boolean)

Indication of injective mapping "id -> attribute". Default value: false.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
layout
object
Required. Layout for storing the dictionary in memory. For in-depth description, see ClickHouse documentation.
clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
layout.
type
string

Required. Layout type for an external dictionary.

  • FLAT: The entire dictionary is stored in memory in the form of flat arrays. Available for all dictionary sources.
  • HASHED: The entire dictionary is stored in memory in the form of a hash table. Available for all dictionary sources.
  • COMPLEX_KEY_HASHED: Similar to HASHED, to be used with composite keys. Available for all dictionary sources.
  • RANGE_HASHED: The entire dictionary is stored in memory in the form of a hash table, with an ordered array of ranges and their corresponding values. Available for all dictionary sources.
  • CACHE: The dictionary is stored in a cache with a set number of cells. Available for MySQL, ClickHouse and HTTP dictionary sources.
  • COMPLEX_KEY_CACHE: Similar to CACHE, to be used with composite keys. Available for MySQL, ClickHouse and HTTP dictionary sources.
clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
layout.
sizeInCells
string (int64)

Number of cells in the cache. Rounded up to a power of two. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
fixedLifetime
string (int64)
clusters[].config.clickhouse.config.userConfig.dictionaries[] includes only one of the fields fixedLifetime, lifetimeRange

Fixed interval between dictionary updates.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
lifetimeRange
object
Range of intervals between dictionary updates for ClickHouse to choose from.
clusters[].config.clickhouse.config.userConfig.dictionaries[] includes only one of the fields fixedLifetime, lifetimeRange
clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
lifetimeRange.
min
string (int64)

Minimum dictionary lifetime.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
lifetimeRange.
max
string (int64)

Maximum dictionary lifetime.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
httpSource
object
HTTP source for the dictionary.
clusters[].config.clickhouse.config.userConfig.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
httpSource.
url
string

Required. URL of the source dictionary available over HTTP.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
httpSource.
format
string

Required. The data format. Valid values are all formats supported by ClickHouse SQL dialect.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource
object
MySQL source for the dictionary.
clusters[].config.clickhouse.config.userConfig.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
db
string

Required. Name of the MySQL database to connect to.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
table
string

Required. Name of the database table to use as a ClickHouse dictionary.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
port
string (int64)

Default port to use when connecting to a replica of the dictionary source.

Acceptable values are 0 to 65535, inclusive.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
user
string

Name of the default user for replicas of the dictionary source.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
password
string

Password of the default user for replicas of the dictionary source.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
replicas[]
object

Required. List of MySQL replicas of the database used as dictionary source.

Must contain at least one element.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
replicas[].
host
string

Required. MySQL host of the replica.

The maximum string length in characters is 253.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
replicas[].
priority
string (int64)

Required. The priority of the replica that ClickHouse takes into account when connecting. Replica with the highest priority should have this field set to the lowest number.

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
replicas[].
port
string (int64)

Port to use when connecting to the replica. If a port is not specified for a replica, ClickHouse uses the port specified for the source.

Acceptable values are 0 to 65535, inclusive.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
replicas[].
user
string

Name of the MySQL database user.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
replicas[].
password
string

Password of the MySQL database user.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
where
string

Selection criteria for the data in the specified MySQL table.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mysqlSource.
invalidateQuery
string

Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
clickhouseSource
object
ClickHouse source for the dictionary.
clusters[].config.clickhouse.config.userConfig.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
clickhouseSource.
db
string

Required. Name of the ClickHouse database.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
clickhouseSource.
table
string

Required. Name of the table in the specified database to be used as the dictionary source.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
clickhouseSource.
host
string

Required. ClickHouse host of the specified database.

The maximum string length in characters is 253.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
clickhouseSource.
port
string (int64)

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
clickhouseSource.
user
string

Required. Name of the ClickHouse database user.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
clickhouseSource.
password
string

Password of the ClickHouse database user.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
clickhouseSource.
where
string

Selection criteria for the data in the specified ClickHouse table.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mongodbSource
object
MongoDB source for the dictionary.
clusters[].config.clickhouse.config.userConfig.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mongodbSource.
db
string

Required. Name of the MongoDB database.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mongodbSource.
collection
string

Required. Name of the collection in the specified database to be used as the dictionary source.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mongodbSource.
host
string

Required. MongoDB host of the specified database.

The maximum string length in characters is 253.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mongodbSource.
port
string (int64)

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mongodbSource.
user
string

Required. Name of the MongoDB database user.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
mongodbSource.
password
string

Password of the MongoDB database user.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
postgresqlSource
object
PostgreSQL source for the dictionary.
clusters[].config.clickhouse.config.userConfig.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
postgresqlSource.
db
string

Required. Name of the PostrgreSQL database.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
postgresqlSource.
table
string

Required. Name of the table in the specified database to be used as the dictionary source.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
postgresqlSource.
hosts[]
string

Required. Name of the PostrgreSQL host

Must contain at least one element.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
postgresqlSource.
port
string (int64)

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
postgresqlSource.
user
string

Required. Name of the PostrgreSQL database user.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
postgresqlSource.
password
string

Password of the PostrgreSQL database user.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
postgresqlSource.
invalidateQuery
string

Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries.

clusters[].
config.
clickhouse.
config.
userConfig.
dictionaries[].
postgresqlSource.
sslMode
string

Mode of SSL TCP/IP connection to the PostgreSQL host. For more details, see PostgreSQL documentation.

  • DISABLE: Only try a non-SSL connection.
  • ALLOW: First try a non-SSL connection; if that fails, try an SSL connection.
  • PREFER: First try an SSL connection; if that fails, try a non-SSL connection.
  • VERIFY_CA: Only try an SSL connection, and verify that the server certificate is issued by a trusted certificate authority (CA).
  • VERIFY_FULL: Only try an SSL connection, verify that the server certificate is issued by a trusted CA and that the requested server host name matches that in the certificate.
clusters[].
config.
clickhouse.
config.
userConfig.
graphiteRollup[]
object

Settings for thinning Graphite data. See in-depth description in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
userConfig.
graphiteRollup[].
name
string

Required. Name for the specified combination of settings for Graphite rollup.

clusters[].
config.
clickhouse.
config.
userConfig.
graphiteRollup[].
patterns[]
object

Required. Pattern to use for the rollup.

Must contain at least one element.

clusters[].
config.
clickhouse.
config.
userConfig.
graphiteRollup[].
patterns[].
regexp
string

Pattern for metric names.

clusters[].
config.
clickhouse.
config.
userConfig.
graphiteRollup[].
patterns[].
function
string

Required. Name of the aggregating function to apply to data of the age specified in retention.

clusters[].
config.
clickhouse.
config.
userConfig.
graphiteRollup[].
patterns[].
retention[]
object

Required. Age of data to use for thinning.

Must contain at least one element.

clusters[].
config.
clickhouse.
config.
userConfig.
graphiteRollup[].
patterns[].
retention[].
age
string (int64)

Minimum age of the data in seconds.

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
userConfig.
graphiteRollup[].
patterns[].
retention[].
precision
string (int64)

Precision of determining the age of the data, in seconds.

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
userConfig.
kafka
object
clusters[].
config.
clickhouse.
config.
userConfig.
kafka.
securityProtocol
string
clusters[].
config.
clickhouse.
config.
userConfig.
kafka.
saslMechanism
string
clusters[].
config.
clickhouse.
config.
userConfig.
kafka.
saslUsername
string
clusters[].
config.
clickhouse.
config.
userConfig.
kafka.
saslPassword
string
clusters[].
config.
clickhouse.
config.
userConfig.
kafkaTopics[]
object
clusters[].
config.
clickhouse.
config.
userConfig.
kafkaTopics[].
name
string

Required.

clusters[].
config.
clickhouse.
config.
userConfig.
kafkaTopics[].
settings
object

Required.

clusters[].
config.
clickhouse.
config.
userConfig.
kafkaTopics[].
settings.
securityProtocol
string
clusters[].
config.
clickhouse.
config.
userConfig.
kafkaTopics[].
settings.
saslMechanism
string
clusters[].
config.
clickhouse.
config.
userConfig.
kafkaTopics[].
settings.
saslUsername
string
clusters[].
config.
clickhouse.
config.
userConfig.
kafkaTopics[].
settings.
saslPassword
string
clusters[].
config.
clickhouse.
config.
userConfig.
rabbitmq
object
clusters[].
config.
clickhouse.
config.
userConfig.
rabbitmq.
username
string

RabbitMQ username

clusters[].
config.
clickhouse.
config.
userConfig.
rabbitmq.
password
string

RabbitMQ password

clusters[].
config.
clickhouse.
config.
userConfig.
rabbitmq.
vhost
string

RabbitMQ virtual host

clusters[].
config.
clickhouse.
config.
userConfig.
maxConnections
integer (int64)

Maximum number of inbound connections.

The minimum value is 10.

clusters[].
config.
clickhouse.
config.
userConfig.
maxConcurrentQueries
integer (int64)

Maximum number of simultaneously processed requests.

The minimum value is 10.

clusters[].
config.
clickhouse.
config.
userConfig.
keepAliveTimeout
integer (int64)

Number of milliseconds that ClickHouse waits for incoming requests before closing the connection.

clusters[].
config.
clickhouse.
config.
userConfig.
uncompressedCacheSize
integer (int64)

Cache size (in bytes) for uncompressed data used by MergeTree tables.

clusters[].
config.
clickhouse.
config.
userConfig.
markCacheSize
integer (int64)

Approximate size (in bytes) of the cache of "marks" used by MergeTree tables.

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
userConfig.
maxTableSizeToDrop
integer (int64)

Maximum size of the table that can be deleted using a DROP query.

clusters[].
config.
clickhouse.
config.
userConfig.
maxPartitionSizeToDrop
integer (int64)

Maximum size of the partition that can be deleted using a DROP query.

clusters[].
config.
clickhouse.
config.
userConfig.
builtinDictionariesReloadInterval
integer (int64)

The setting is deprecated and has no effect.

clusters[].
config.
clickhouse.
config.
userConfig.
timezone
string

The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier.

clusters[].
config.
clickhouse.
config.
userConfig.
geobaseUri
string

Address of the archive with the user geobase in Object Storage.

clusters[].
config.
clickhouse.
config.
userConfig.
queryLogRetentionSize
integer (int64)

The maximum size that query_log can grow to before old data will be removed. If set to 0, automatic removal of query_log data based on size is disabled.

clusters[].
config.
clickhouse.
config.
userConfig.
queryLogRetentionTime
integer (int64)

The maximum time that query_log records will be retained before removal. If set to 0, automatic removal of query_log data based on time is disabled.

clusters[].
config.
clickhouse.
config.
userConfig.
queryThreadLogEnabled
boolean (boolean)

Whether query_thread_log system table is enabled.

clusters[].
config.
clickhouse.
config.
userConfig.
queryThreadLogRetentionSize
integer (int64)

The maximum size that query_thread_log can grow to before old data will be removed. If set to 0, automatic removal of query_thread_log data based on size is disabled.

clusters[].
config.
clickhouse.
config.
userConfig.
queryThreadLogRetentionTime
integer (int64)

The maximum time that query_thread_log records will be retained before removal. If set to 0, automatic removal of query_thread_log data based on time is disabled.

clusters[].
config.
clickhouse.
config.
userConfig.
partLogRetentionSize
integer (int64)

The maximum size that part_log can grow to before old data will be removed. If set to 0, automatic removal of part_log data based on size is disabled.

clusters[].
config.
clickhouse.
config.
userConfig.
partLogRetentionTime
integer (int64)

The maximum time that part_log records will be retained before removal. If set to 0, automatic removal of part_log data based on time is disabled.

clusters[].
config.
clickhouse.
config.
userConfig.
metricLogEnabled
boolean (boolean)

Whether metric_log system table is enabled.

clusters[].
config.
clickhouse.
config.
userConfig.
metricLogRetentionSize
integer (int64)

The maximum size that metric_log can grow to before old data will be removed. If set to 0, automatic removal of metric_log data based on size is disabled.

clusters[].
config.
clickhouse.
config.
userConfig.
metricLogRetentionTime
integer (int64)

The maximum time that metric_log records will be retained before removal. If set to 0, automatic removal of metric_log data based on time is disabled.

clusters[].
config.
clickhouse.
config.
userConfig.
traceLogEnabled
boolean (boolean)

Whether trace_log system table is enabled.

clusters[].
config.
clickhouse.
config.
userConfig.
traceLogRetentionSize
integer (int64)

The maximum size that trace_log can grow to before old data will be removed. If set to 0, automatic removal of trace_log data based on size is disabled.

clusters[].
config.
clickhouse.
config.
userConfig.
traceLogRetentionTime
integer (int64)

The maximum time that trace_log records will be retained before removal. If set to 0, automatic removal of trace_log data based on time is disabled.

clusters[].
config.
clickhouse.
config.
userConfig.
textLogEnabled
boolean (boolean)

Whether text_log system table is enabled.

clusters[].
config.
clickhouse.
config.
userConfig.
textLogRetentionSize
integer (int64)

The maximum size that text_log can grow to before old data will be removed. If set to 0, automatic removal of text_log data based on size is disabled.

clusters[].
config.
clickhouse.
config.
userConfig.
textLogRetentionTime
integer (int64)

The maximum time that text_log records will be retained before removal. If set to 0, automatic removal of text_log data based on time is disabled.

clusters[].
config.
clickhouse.
config.
userConfig.
textLogLevel
string

Logging level for text_log system table. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.

clusters[].
config.
clickhouse.
config.
userConfig.
opentelemetrySpanLogEnabled
boolean (boolean)
clusters[].
config.
clickhouse.
config.
userConfig.
backgroundPoolSize
integer (int64)

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
userConfig.
backgroundSchedulePoolSize
integer (int64)

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
userConfig.
backgroundFetchesPoolSize
integer (int64)

Sets the number of threads performing background fetches for tables with ReplicatedMergeTree engines. Default value: 8.

More info see in ClickHouse documentation.

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
userConfig.
backgroundMovePoolSize
integer (int64)

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
userConfig.
backgroundDistributedSchedulePoolSize
integer (int64)

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
userConfig.
backgroundBufferFlushSchedulePoolSize
integer (int64)

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
userConfig.
defaultDatabase
string

The default database.

To get a list of cluster databases, see Yandex Managed ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
userConfig.
totalMemoryProfilerStep
integer (int64)

Sets the memory size (in bytes) for a stack trace at every peak allocation step. Default value: 4194304.

More info see in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
userConfig.
totalMemoryTrackerSampleProbability
number (double)
clusters[].
config.
clickhouse.
config.
defaultConfig
object

Default configuration for a ClickHouse cluster.

ClickHouse configuration options. Detailed description for each set of options is available in ClickHouse documentation.

Any options not listed here are not supported.

clusters[].
config.
clickhouse.
config.
defaultConfig.
logLevel
string

Logging level for the ClickHouse cluster. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.

clusters[].
config.
clickhouse.
config.
defaultConfig.
mergeTree
object

Settings for the MergeTree engine. See description in ClickHouse documentation.

Options specific to the MergeTree table engine.

clusters[].
config.
clickhouse.
config.
defaultConfig.
mergeTree.
replicatedDeduplicationWindow
integer (int64)

Number of blocks of hashes to keep in ZooKeeper.

clusters[].
config.
clickhouse.
config.
defaultConfig.
mergeTree.
replicatedDeduplicationWindowSeconds
integer (int64)

Period of time to keep blocks of hashes for.

clusters[].
config.
clickhouse.
config.
defaultConfig.
mergeTree.
partsToDelayInsert
integer (int64)

If table contains at least that many active parts in single partition, artificially slow down insert into table.

clusters[].
config.
clickhouse.
config.
defaultConfig.
mergeTree.
partsToThrowInsert
integer (int64)

If more than this number active parts in single partition, throw 'Too many parts ...' exception.

clusters[].
config.
clickhouse.
config.
defaultConfig.
mergeTree.
inactivePartsToDelayInsert
integer (int64)
clusters[].
config.
clickhouse.
config.
defaultConfig.
mergeTree.
inactivePartsToThrowInsert
integer (int64)
clusters[].
config.
clickhouse.
config.
defaultConfig.
mergeTree.
maxReplicatedMergesInQueue
integer (int64)

How many tasks of merging and mutating parts are allowed simultaneously in ReplicatedMergeTree queue.

clusters[].
config.
clickhouse.
config.
defaultConfig.
mergeTree.
numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge
integer (int64)

If there is less than specified number of free entries in background pool (or replicated queue), start to lower maximum size of merge to process.

clusters[].
config.
clickhouse.
config.
defaultConfig.
mergeTree.
maxBytesToMergeAtMinSpaceInPool
integer (int64)

Maximum in total size of parts to merge, when there are minimum free threads in background pool (or entries in replication queue).

clusters[].
config.
clickhouse.
config.
defaultConfig.
mergeTree.
maxBytesToMergeAtMaxSpaceInPool
integer (int64)
clusters[].
config.
clickhouse.
config.
defaultConfig.
mergeTree.
minBytesForWidePart
integer (int64)

Minimum number of bytes in a data part that can be stored in Wide format.

More info see in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
defaultConfig.
mergeTree.
minRowsForWidePart
integer (int64)

Minimum number of rows in a data part that can be stored in Wide format.

More info see in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
defaultConfig.
mergeTree.
ttlOnlyDropParts
boolean (boolean)

Enables or disables complete dropping of data parts where all rows are expired in MergeTree tables.

More info see in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
defaultConfig.
mergeTree.
allowRemoteFsZeroCopyReplication
boolean (boolean)
clusters[].
config.
clickhouse.
config.
defaultConfig.
compression[]
object

Compression settings for the ClickHouse cluster. See in-depth description in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
defaultConfig.
compression[].
method
string

Compression method to use for the specified combination of minPartSize and minPartSizeRatio.

  • LZ4: LZ4 compression algorithm.
  • ZSTD: Zstandard compression algorithm.
clusters[].
config.
clickhouse.
config.
defaultConfig.
compression[].
minPartSize
string (int64)

Minimum size of a part of a table.

The minimum value is 1.

clusters[].
config.
clickhouse.
config.
defaultConfig.
compression[].
minPartSizeRatio
number (double)

Minimum ratio of a part relative to the size of all the data in the table.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[]
object

Configuration of external dictionaries to be used by the ClickHouse cluster. See in-depth description in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
name
string

Required. Name of the external dictionary.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure
object
Required. Set of attributes for the external dictionary. For in-depth description, see ClickHouse documentation.
clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
id
object

Single numeric key column for the dictionary.

Numeric key.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
id.
name
string

Required. Name of the numeric key.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
key
object

Composite key for the dictionary, containing of one or more key columns. For details, see ClickHouse documentation.

Complex key.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
key.
attributes[]
object

Required. Attributes of a complex key.

Must contain at least one element.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
key.
attributes[].
name
string

Required. Name of the column.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
key.
attributes[].
type
string

Required. Type of the column.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
key.
attributes[].
nullValue
string

Default value for an element without data (for example, an empty string).

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
key.
attributes[].
expression
string

Expression, describing the attribute, if applicable.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
key.
attributes[].
hierarchical
boolean (boolean)

Indication of hierarchy support. Default value: false.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
key.
attributes[].
injective
boolean (boolean)

Indication of injective mapping "id -> attribute". Default value: false.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMin
object

Field holding the beginning of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMin.
name
string

Required. Name of the column.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMin.
type
string

Required. Type of the column.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMin.
nullValue
string

Default value for an element without data (for example, an empty string).

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMin.
expression
string

Expression, describing the attribute, if applicable.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMin.
hierarchical
boolean (boolean)

Indication of hierarchy support. Default value: false.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMin.
injective
boolean (boolean)

Indication of injective mapping "id -> attribute". Default value: false.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMax
object

Field holding the end of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMax.
name
string

Required. Name of the column.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMax.
type
string

Required. Type of the column.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMax.
nullValue
string

Default value for an element without data (for example, an empty string).

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMax.
expression
string

Expression, describing the attribute, if applicable.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMax.
hierarchical
boolean (boolean)

Indication of hierarchy support. Default value: false.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
rangeMax.
injective
boolean (boolean)

Indication of injective mapping "id -> attribute". Default value: false.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
attributes[]
object

Required. Description of the fields available for database queries. For details, see ClickHouse documentation.

Must contain at least one element.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
attributes[].
name
string

Required. Name of the column.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
attributes[].
type
string

Required. Type of the column.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
attributes[].
nullValue
string

Default value for an element without data (for example, an empty string).

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
attributes[].
expression
string

Expression, describing the attribute, if applicable.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
attributes[].
hierarchical
boolean (boolean)

Indication of hierarchy support. Default value: false.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
structure.
attributes[].
injective
boolean (boolean)

Indication of injective mapping "id -> attribute". Default value: false.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
layout
object
Required. Layout for storing the dictionary in memory. For in-depth description, see ClickHouse documentation.
clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
layout.
type
string

Required. Layout type for an external dictionary.

  • FLAT: The entire dictionary is stored in memory in the form of flat arrays. Available for all dictionary sources.
  • HASHED: The entire dictionary is stored in memory in the form of a hash table. Available for all dictionary sources.
  • COMPLEX_KEY_HASHED: Similar to HASHED, to be used with composite keys. Available for all dictionary sources.
  • RANGE_HASHED: The entire dictionary is stored in memory in the form of a hash table, with an ordered array of ranges and their corresponding values. Available for all dictionary sources.
  • CACHE: The dictionary is stored in a cache with a set number of cells. Available for MySQL, ClickHouse and HTTP dictionary sources.
  • COMPLEX_KEY_CACHE: Similar to CACHE, to be used with composite keys. Available for MySQL, ClickHouse and HTTP dictionary sources.
clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
layout.
sizeInCells
string (int64)

Number of cells in the cache. Rounded up to a power of two. Applicable only for CACHE and COMPLEX_KEY_CACHE layout types.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
fixedLifetime
string (int64)
clusters[].config.clickhouse.config.defaultConfig.dictionaries[] includes only one of the fields fixedLifetime, lifetimeRange

Fixed interval between dictionary updates.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
lifetimeRange
object
Range of intervals between dictionary updates for ClickHouse to choose from.
clusters[].config.clickhouse.config.defaultConfig.dictionaries[] includes only one of the fields fixedLifetime, lifetimeRange
clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
lifetimeRange.
min
string (int64)

Minimum dictionary lifetime.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
lifetimeRange.
max
string (int64)

Maximum dictionary lifetime.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
httpSource
object
HTTP source for the dictionary.
clusters[].config.clickhouse.config.defaultConfig.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
httpSource.
url
string

Required. URL of the source dictionary available over HTTP.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
httpSource.
format
string

Required. The data format. Valid values are all formats supported by ClickHouse SQL dialect.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource
object
MySQL source for the dictionary.
clusters[].config.clickhouse.config.defaultConfig.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
db
string

Required. Name of the MySQL database to connect to.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
table
string

Required. Name of the database table to use as a ClickHouse dictionary.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
port
string (int64)

Default port to use when connecting to a replica of the dictionary source.

Acceptable values are 0 to 65535, inclusive.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
user
string

Name of the default user for replicas of the dictionary source.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
password
string

Password of the default user for replicas of the dictionary source.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
replicas[]
object

Required. List of MySQL replicas of the database used as dictionary source.

Must contain at least one element.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
replicas[].
host
string

Required. MySQL host of the replica.

The maximum string length in characters is 253.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
replicas[].
priority
string (int64)

Required. The priority of the replica that ClickHouse takes into account when connecting. Replica with the highest priority should have this field set to the lowest number.

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
replicas[].
port
string (int64)

Port to use when connecting to the replica. If a port is not specified for a replica, ClickHouse uses the port specified for the source.

Acceptable values are 0 to 65535, inclusive.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
replicas[].
user
string

Name of the MySQL database user.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
replicas[].
password
string

Password of the MySQL database user.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
where
string

Selection criteria for the data in the specified MySQL table.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mysqlSource.
invalidateQuery
string

Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
clickhouseSource
object
ClickHouse source for the dictionary.
clusters[].config.clickhouse.config.defaultConfig.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
clickhouseSource.
db
string

Required. Name of the ClickHouse database.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
clickhouseSource.
table
string

Required. Name of the table in the specified database to be used as the dictionary source.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
clickhouseSource.
host
string

Required. ClickHouse host of the specified database.

The maximum string length in characters is 253.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
clickhouseSource.
port
string (int64)

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
clickhouseSource.
user
string

Required. Name of the ClickHouse database user.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
clickhouseSource.
password
string

Password of the ClickHouse database user.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
clickhouseSource.
where
string

Selection criteria for the data in the specified ClickHouse table.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mongodbSource
object
MongoDB source for the dictionary.
clusters[].config.clickhouse.config.defaultConfig.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mongodbSource.
db
string

Required. Name of the MongoDB database.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mongodbSource.
collection
string

Required. Name of the collection in the specified database to be used as the dictionary source.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mongodbSource.
host
string

Required. MongoDB host of the specified database.

The maximum string length in characters is 253.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mongodbSource.
port
string (int64)

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mongodbSource.
user
string

Required. Name of the MongoDB database user.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
mongodbSource.
password
string

Password of the MongoDB database user.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
postgresqlSource
object
PostgreSQL source for the dictionary.
clusters[].config.clickhouse.config.defaultConfig.dictionaries[] includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource
clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
postgresqlSource.
db
string

Required. Name of the PostrgreSQL database.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
postgresqlSource.
table
string

Required. Name of the table in the specified database to be used as the dictionary source.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
postgresqlSource.
hosts[]
string

Required. Name of the PostrgreSQL host

Must contain at least one element.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
postgresqlSource.
port
string (int64)

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
postgresqlSource.
user
string

Required. Name of the PostrgreSQL database user.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
postgresqlSource.
password
string

Password of the PostrgreSQL database user.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
postgresqlSource.
invalidateQuery
string

Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries.

clusters[].
config.
clickhouse.
config.
defaultConfig.
dictionaries[].
postgresqlSource.
sslMode
string

Mode of SSL TCP/IP connection to the PostgreSQL host. For more details, see PostgreSQL documentation.

  • DISABLE: Only try a non-SSL connection.
  • ALLOW: First try a non-SSL connection; if that fails, try an SSL connection.
  • PREFER: First try an SSL connection; if that fails, try a non-SSL connection.
  • VERIFY_CA: Only try an SSL connection, and verify that the server certificate is issued by a trusted certificate authority (CA).
  • VERIFY_FULL: Only try an SSL connection, verify that the server certificate is issued by a trusted CA and that the requested server host name matches that in the certificate.
clusters[].
config.
clickhouse.
config.
defaultConfig.
graphiteRollup[]
object

Settings for thinning Graphite data. See in-depth description in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
defaultConfig.
graphiteRollup[].
name
string

Required. Name for the specified combination of settings for Graphite rollup.

clusters[].
config.
clickhouse.
config.
defaultConfig.
graphiteRollup[].
patterns[]
object

Required. Pattern to use for the rollup.

Must contain at least one element.

clusters[].
config.
clickhouse.
config.
defaultConfig.
graphiteRollup[].
patterns[].
regexp
string

Pattern for metric names.

clusters[].
config.
clickhouse.
config.
defaultConfig.
graphiteRollup[].
patterns[].
function
string

Required. Name of the aggregating function to apply to data of the age specified in retention.

clusters[].
config.
clickhouse.
config.
defaultConfig.
graphiteRollup[].
patterns[].
retention[]
object

Required. Age of data to use for thinning.

Must contain at least one element.

clusters[].
config.
clickhouse.
config.
defaultConfig.
graphiteRollup[].
patterns[].
retention[].
age
string (int64)

Minimum age of the data in seconds.

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
defaultConfig.
graphiteRollup[].
patterns[].
retention[].
precision
string (int64)

Precision of determining the age of the data, in seconds.

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
defaultConfig.
kafka
object
clusters[].
config.
clickhouse.
config.
defaultConfig.
kafka.
securityProtocol
string
clusters[].
config.
clickhouse.
config.
defaultConfig.
kafka.
saslMechanism
string
clusters[].
config.
clickhouse.
config.
defaultConfig.
kafka.
saslUsername
string
clusters[].
config.
clickhouse.
config.
defaultConfig.
kafka.
saslPassword
string
clusters[].
config.
clickhouse.
config.
defaultConfig.
kafkaTopics[]
object
clusters[].
config.
clickhouse.
config.
defaultConfig.
kafkaTopics[].
name
string

Required.

clusters[].
config.
clickhouse.
config.
defaultConfig.
kafkaTopics[].
settings
object

Required.

clusters[].
config.
clickhouse.
config.
defaultConfig.
kafkaTopics[].
settings.
securityProtocol
string
clusters[].
config.
clickhouse.
config.
defaultConfig.
kafkaTopics[].
settings.
saslMechanism
string
clusters[].
config.
clickhouse.
config.
defaultConfig.
kafkaTopics[].
settings.
saslUsername
string
clusters[].
config.
clickhouse.
config.
defaultConfig.
kafkaTopics[].
settings.
saslPassword
string
clusters[].
config.
clickhouse.
config.
defaultConfig.
rabbitmq
object
clusters[].
config.
clickhouse.
config.
defaultConfig.
rabbitmq.
username
string

RabbitMQ username

clusters[].
config.
clickhouse.
config.
defaultConfig.
rabbitmq.
password
string

RabbitMQ password

clusters[].
config.
clickhouse.
config.
defaultConfig.
rabbitmq.
vhost
string

RabbitMQ virtual host

clusters[].
config.
clickhouse.
config.
defaultConfig.
maxConnections
integer (int64)

Maximum number of inbound connections.

The minimum value is 10.

clusters[].
config.
clickhouse.
config.
defaultConfig.
maxConcurrentQueries
integer (int64)

Maximum number of simultaneously processed requests.

The minimum value is 10.

clusters[].
config.
clickhouse.
config.
defaultConfig.
keepAliveTimeout
integer (int64)

Number of milliseconds that ClickHouse waits for incoming requests before closing the connection.

clusters[].
config.
clickhouse.
config.
defaultConfig.
uncompressedCacheSize
integer (int64)

Cache size (in bytes) for uncompressed data used by MergeTree tables.

clusters[].
config.
clickhouse.
config.
defaultConfig.
markCacheSize
integer (int64)

Approximate size (in bytes) of the cache of "marks" used by MergeTree tables.

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
defaultConfig.
maxTableSizeToDrop
integer (int64)

Maximum size of the table that can be deleted using a DROP query.

clusters[].
config.
clickhouse.
config.
defaultConfig.
maxPartitionSizeToDrop
integer (int64)

Maximum size of the partition that can be deleted using a DROP query.

clusters[].
config.
clickhouse.
config.
defaultConfig.
builtinDictionariesReloadInterval
integer (int64)

The setting is deprecated and has no effect.

clusters[].
config.
clickhouse.
config.
defaultConfig.
timezone
string

The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier.

clusters[].
config.
clickhouse.
config.
defaultConfig.
geobaseUri
string

Address of the archive with the user geobase in Object Storage.

clusters[].
config.
clickhouse.
config.
defaultConfig.
queryLogRetentionSize
integer (int64)

The maximum size that query_log can grow to before old data will be removed. If set to 0, automatic removal of query_log data based on size is disabled.

clusters[].
config.
clickhouse.
config.
defaultConfig.
queryLogRetentionTime
integer (int64)

The maximum time that query_log records will be retained before removal. If set to 0, automatic removal of query_log data based on time is disabled.

clusters[].
config.
clickhouse.
config.
defaultConfig.
queryThreadLogEnabled
boolean (boolean)

Whether query_thread_log system table is enabled.

clusters[].
config.
clickhouse.
config.
defaultConfig.
queryThreadLogRetentionSize
integer (int64)

The maximum size that query_thread_log can grow to before old data will be removed. If set to 0, automatic removal of query_thread_log data based on size is disabled.

clusters[].
config.
clickhouse.
config.
defaultConfig.
queryThreadLogRetentionTime
integer (int64)

The maximum time that query_thread_log records will be retained before removal. If set to 0, automatic removal of query_thread_log data based on time is disabled.

clusters[].
config.
clickhouse.
config.
defaultConfig.
partLogRetentionSize
integer (int64)

The maximum size that part_log can grow to before old data will be removed. If set to 0, automatic removal of part_log data based on size is disabled.

clusters[].
config.
clickhouse.
config.
defaultConfig.
partLogRetentionTime
integer (int64)

The maximum time that part_log records will be retained before removal. If set to 0, automatic removal of part_log data based on time is disabled.

clusters[].
config.
clickhouse.
config.
defaultConfig.
metricLogEnabled
boolean (boolean)

Whether metric_log system table is enabled.

clusters[].
config.
clickhouse.
config.
defaultConfig.
metricLogRetentionSize
integer (int64)

The maximum size that metric_log can grow to before old data will be removed. If set to 0, automatic removal of metric_log data based on size is disabled.

clusters[].
config.
clickhouse.
config.
defaultConfig.
metricLogRetentionTime
integer (int64)

The maximum time that metric_log records will be retained before removal. If set to 0, automatic removal of metric_log data based on time is disabled.

clusters[].
config.
clickhouse.
config.
defaultConfig.
traceLogEnabled
boolean (boolean)

Whether trace_log system table is enabled.

clusters[].
config.
clickhouse.
config.
defaultConfig.
traceLogRetentionSize
integer (int64)

The maximum size that trace_log can grow to before old data will be removed. If set to 0, automatic removal of trace_log data based on size is disabled.

clusters[].
config.
clickhouse.
config.
defaultConfig.
traceLogRetentionTime
integer (int64)

The maximum time that trace_log records will be retained before removal. If set to 0, automatic removal of trace_log data based on time is disabled.

clusters[].
config.
clickhouse.
config.
defaultConfig.
textLogEnabled
boolean (boolean)

Whether text_log system table is enabled.

clusters[].
config.
clickhouse.
config.
defaultConfig.
textLogRetentionSize
integer (int64)

The maximum size that text_log can grow to before old data will be removed. If set to 0, automatic removal of text_log data based on size is disabled.

clusters[].
config.
clickhouse.
config.
defaultConfig.
textLogRetentionTime
integer (int64)

The maximum time that text_log records will be retained before removal. If set to 0, automatic removal of text_log data based on time is disabled.

clusters[].
config.
clickhouse.
config.
defaultConfig.
textLogLevel
string

Logging level for text_log system table. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.

clusters[].
config.
clickhouse.
config.
defaultConfig.
opentelemetrySpanLogEnabled
boolean (boolean)
clusters[].
config.
clickhouse.
config.
defaultConfig.
backgroundPoolSize
integer (int64)

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
defaultConfig.
backgroundSchedulePoolSize
integer (int64)

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
defaultConfig.
backgroundFetchesPoolSize
integer (int64)

Sets the number of threads performing background fetches for tables with ReplicatedMergeTree engines. Default value: 8.

More info see in ClickHouse documentation.

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
defaultConfig.
backgroundMovePoolSize
integer (int64)

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
defaultConfig.
backgroundDistributedSchedulePoolSize
integer (int64)

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
defaultConfig.
backgroundBufferFlushSchedulePoolSize
integer (int64)

Value must be greater than 0.

clusters[].
config.
clickhouse.
config.
defaultConfig.
defaultDatabase
string

The default database.

To get a list of cluster databases, see Yandex Managed ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
defaultConfig.
totalMemoryProfilerStep
integer (int64)

Sets the memory size (in bytes) for a stack trace at every peak allocation step. Default value: 4194304.

More info see in ClickHouse documentation.

clusters[].
config.
clickhouse.
config.
defaultConfig.
totalMemoryTrackerSampleProbability
number (double)
clusters[].
config.
clickhouse.
resources
object

Resources allocated to ClickHouse hosts.

clusters[].
config.
clickhouse.
resources.
resourcePresetId
string

ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation

clusters[].
config.
clickhouse.
resources.
diskSize
string (int64)

Volume of the storage available to a host, in bytes.

clusters[].
config.
clickhouse.
resources.
diskTypeId
string

Type of the storage environment for the host. Possible values:

  • network-hdd - network HDD drive,
  • network-ssd - network SSD drive,
  • local-ssd - local SSD storage.
clusters[].
config.
zookeeper
object

Configuration and resource allocation for ZooKeeper hosts.

clusters[].
config.
zookeeper.
resources
object

Resources allocated to ZooKeeper hosts.

clusters[].
config.
zookeeper.
resources.
resourcePresetId
string

ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation

clusters[].
config.
zookeeper.
resources.
diskSize
string (int64)

Volume of the storage available to a host, in bytes.

clusters[].
config.
zookeeper.
resources.
diskTypeId
string

Type of the storage environment for the host. Possible values:

  • network-hdd - network HDD drive,
  • network-ssd - network SSD drive,
  • local-ssd - local SSD storage.
clusters[].
config.
backupWindowStart
object

Time to start the daily backup, in the UTC timezone.

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

clusters[].
config.
backupWindowStart.
hours
integer (int32)

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

clusters[].
config.
backupWindowStart.
minutes
integer (int32)

Minutes of hour of day. Must be from 0 to 59.

clusters[].
config.
backupWindowStart.
seconds
integer (int32)

Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

clusters[].
config.
backupWindowStart.
nanos
integer (int32)

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

clusters[].
config.
access
object

Access policy for external services.

clusters[].
config.
access.
dataLens
boolean (boolean)

Allow to export data from the cluster to DataLens.

clusters[].
config.
access.
webSql
boolean (boolean)

Allow SQL queries to the cluster databases from the management console.

See SQL queries in the management console for more details.

clusters[].
config.
access.
metrika
boolean (boolean)

Allow to import data from Yandex Metrica and AppMetrica to the cluster.

See AppMetrica documentation for more details.

clusters[].
config.
access.
serverless
boolean (boolean)

Allow access to cluster for Serverless.

clusters[].
config.
access.
dataTransfer
boolean (boolean)

Allow access for DataTransfer

clusters[].
config.
access.
yandexQuery
boolean (boolean)

Allow access for Query

clusters[].
config.
cloudStorage
object
clusters[].
config.
cloudStorage.
enabled
boolean (boolean)

Whether to use Object Storage for storing ClickHouse data.

clusters[].
config.
cloudStorage.
moveFactor
number (double)

Acceptable values are 0 to 1, inclusive.

clusters[].
config.
cloudStorage.
dataCacheEnabled
boolean (boolean)
clusters[].
config.
cloudStorage.
dataCacheMaxSize
integer (int64)
clusters[].
config.
sqlDatabaseManagement
boolean (boolean)

Whether database management through SQL commands is enabled.

clusters[].
config.
sqlUserManagement
boolean (boolean)

Whether user management through SQL commands is enabled.

clusters[].
config.
embeddedKeeper
boolean (boolean)

Whether cluster should use embedded Keeper instead of Zookeeper.

clusters[].
networkId
string

ID of the network that the cluster belongs to.

clusters[].
health
string

Aggregated cluster health.

  • HEALTH_UNKNOWN: State of the cluster is unknown (health for every host in the cluster is UNKNOWN).
  • ALIVE: Cluster is alive and well (health for every host in the cluster is ALIVE).
  • DEAD: Cluster is inoperable (health for every host in the cluster is DEAD).
  • DEGRADED: Cluster is working below capacity (health for at least one host in the cluster is not ALIVE).
clusters[].
status
string

Current state of the cluster.

  • STATUS_UNKNOWN: Cluster state is unknown.
  • CREATING: Cluster is being created.
  • RUNNING: Cluster is running normally.
  • ERROR: Cluster encountered a problem and cannot operate.
  • UPDATING: Cluster is being updated.
  • STOPPING: Cluster is stopping.
  • STOPPED: Cluster stopped.
  • STARTING: Cluster is starting.
clusters[].
serviceAccountId
string

ID of the service account used for access to Object Storage.

clusters[].
maintenanceWindow
object

Maintenance window for the cluster.

A maintenance window settings.

clusters[].
maintenanceWindow.
anytime
object
Maintenance operation can be scheduled anytime.
clusters[].maintenanceWindow includes only one of the fields anytime, weeklyMaintenanceWindow
clusters[].
maintenanceWindow.
weeklyMaintenanceWindow
object
Maintenance operation can be scheduled on a weekly basis.
clusters[].maintenanceWindow includes only one of the fields anytime, weeklyMaintenanceWindow
clusters[].
maintenanceWindow.
weeklyMaintenanceWindow.
day
string

Day of the week (in DDD format).

clusters[].
maintenanceWindow.
weeklyMaintenanceWindow.
hour
string (int64)

Hour of the day in UTC (in HH format).

Acceptable values are 1 to 24, inclusive.

clusters[].
plannedOperation
object

Planned maintenance operation to be started for the cluster within the nearest maintenanceWindow.

A planned maintenance operation.

clusters[].
plannedOperation.
info
string

Information about this maintenance operation.

The maximum string length in characters is 256.

clusters[].
plannedOperation.
delayedUntil
string (date-time)

Time until which this maintenance operation is delayed.

String in RFC3339 text format. The range of possible values is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

clusters[].
securityGroupIds[]
string

User security groups

clusters[].
deletionProtection
boolean (boolean)

Deletion Protection inhibits deletion of the cluster

nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.

Была ли статья полезна?

Language / Region
Проект Яндекса
© 2023 ООО «Яндекс.Облако»
В этой статье:
  • HTTP request
  • Query parameters
  • Response