Yandex Cloud
Поиск
Связаться с намиПопробовать бесплатно
  • Кейсы
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
  • Marketplace
    • Доступны в регионе
    • Инфраструктура и сеть
    • Платформа данных
    • Искусственный интеллект
    • Безопасность
    • Инструменты DevOps
    • Бессерверные вычисления
    • Управление ресурсами
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Партнёрская программа
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Калькулятор цен
    • Тарифы
    • Акции и free tier
  • Кейсы
  • Документация
  • Блог
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Проект Яндекса
© 2026 ТОО «Облачные Сервисы Казахстан»
Yandex Audit Trails
KZ
  • Начало работы
  • Управление доступом
  • Правила тарификации
  • Справочник Terraform
  • Метрики Monitoring
  • Справочник событий уровня конфигурации
  • Справочник событий уровня сервисов
      • AddClusterHosts
      • AddClusterShard
      • AddClusterShards
      • AddClusterZookeeper
      • BackupCluster
      • CreateCluster
      • CreateClusterExtension
      • CreateClusterExternalDictionary
      • CreateDatabase
      • CreateFormatSchema
      • CreateMlModel
      • CreateShardGroup
      • CreateUser
      • DatabaseUserLogin
      • DatabaseUserLogout
      • DatabaseUserSQLRequest
      • DeleteBackup
      • DeleteCluster
      • DeleteClusterExtension
      • DeleteClusterExternalDictionary
      • DeleteClusterHosts
      • DeleteClusterShard
      • DeleteClusterShards
      • DeleteDatabase
      • DeleteFormatSchema
      • DeleteMlModel
      • DeleteShardGroup
      • DeleteUser
      • GetDatabase
      • GetUser
      • GrantUserPermission
      • ListDatabases
      • ListUsers
      • MoveCluster
      • RescheduleMaintenance
      • RestartClusterHosts
      • RestoreCluster
      • RevokeUserPermission
      • SetClusterAccessBindings
      • SetClusterExtensions
      • StartCluster
      • StopCluster
      • UpdateCluster
      • UpdateClusterAccessBindings
      • UpdateClusterExtension
      • UpdateClusterExternalDictionary
      • UpdateClusterHosts
      • UpdateClusterShard
      • UpdateFormatSchema
      • UpdateMlModel
      • UpdateShardGroup
      • UpdateUser
  • История изменений
  • Обучающие курсы

В этой статье:

  • Event JSON schema
  • Field description
  • IamAuthentication
  • IamTokenInfo
  • Authorization
  • ResourceMetadata
  • Resource
  • RequestMetadata
  • Status
  • ClusterCreateEventDetails
  • Cluster
  • Monitoring
  • ClusterConfig
  • Clickhouse
  • ClickhouseConfigSet
  • ClickhouseConfig
  • AccessControlImprovements
  • MergeTree
  • Compression
  • ExternalDictionary
  • Structure
  • Id
  • Key
  • Attribute
  • Layout
  • Range
  • HttpSource
  • Header
  • MysqlSource
  • Replica
  • ClickhouseSource
  • MongodbSource
  • PostgresqlSource
  • GraphiteRollup
  • Pattern
  • Retention
  • Kafka
  • KafkaTopic
  • Rabbitmq
  • QueryMaskingRule
  • QueryCache
  • JdbcBridge
  • Macro
  • Resources
  • DiskSizeAutoscaling
  • Zookeeper
  • TimeOfDay
  • Access
  • CloudStorage
  • PerformanceDiagnostics
  • MaintenanceWindow
  • WeeklyMaintenanceWindow
  • MaintenanceOperation
  • HostDetails
  • Service
  • Database
  • User
  • Permission
  • UserSettings
  • UserQuota
  • ConnectionManager
  1. Справочник аудитных логов (англ.)
  2. mdb.clickhouse
  3. CreateCluster

Managed Service for ClickHouse Audit Trails Events: CreateCluster

Статья создана
Yandex Cloud
Обновлена 15 апреля 2026 г.
  • Event JSON schema
  • Field description
  • IamAuthentication
  • IamTokenInfo
  • Authorization
  • ResourceMetadata
  • Resource
  • RequestMetadata
  • Status
  • ClusterCreateEventDetails
  • Cluster
  • Monitoring
  • ClusterConfig
  • Clickhouse
  • ClickhouseConfigSet
  • ClickhouseConfig
  • AccessControlImprovements
  • MergeTree
  • Compression
  • ExternalDictionary
  • Structure
  • Id
  • Key
  • Attribute
  • Layout
  • Range
  • HttpSource
  • Header
  • MysqlSource
  • Replica
  • ClickhouseSource
  • MongodbSource
  • PostgresqlSource
  • GraphiteRollup
  • Pattern
  • Retention
  • Kafka
  • KafkaTopic
  • Rabbitmq
  • QueryMaskingRule
  • QueryCache
  • JdbcBridge
  • Macro
  • Resources
  • DiskSizeAutoscaling
  • Zookeeper
  • TimeOfDay
  • Access
  • CloudStorage
  • PerformanceDiagnostics
  • MaintenanceWindow
  • WeeklyMaintenanceWindow
  • MaintenanceOperation
  • HostDetails
  • Service
  • Database
  • User
  • Permission
  • UserSettings
  • UserQuota
  • ConnectionManager

Event JSON schemaEvent JSON schema

{
  "eventId": "string",
  "eventSource": "string",
  "eventType": "string",
  "eventTime": "string",
  "authentication": {
    "authenticated": "boolean",
    // Includes only one of the fields `subjectType`
    "subjectType": "string",
    // end of the list of possible fields
    // Includes only one of the fields `subjectId`
    "subjectId": "string",
    // end of the list of possible fields
    // Includes only one of the fields `subjectName`
    "subjectName": "string",
    // end of the list of possible fields
    // Includes only one of the fields `federationId`
    "federationId": "string",
    // end of the list of possible fields
    // Includes only one of the fields `federationName`
    "federationName": "string",
    // end of the list of possible fields
    // Includes only one of the fields `federationType`
    "federationType": "string",
    // end of the list of possible fields
    "tokenInfo": {
      "maskedIamToken": "string",
      // Includes only one of the fields `iamTokenId`
      "iamTokenId": "string",
      // end of the list of possible fields
      // Includes only one of the fields `impersonatorId`
      "impersonatorId": "string",
      // end of the list of possible fields
      // Includes only one of the fields `impersonatorType`
      "impersonatorType": "string",
      // end of the list of possible fields
      // Includes only one of the fields `impersonatorName`
      "impersonatorName": "string",
      // end of the list of possible fields
      // Includes only one of the fields `impersonatorFederationId`
      "impersonatorFederationId": "string",
      // end of the list of possible fields
      // Includes only one of the fields `impersonatorFederationName`
      "impersonatorFederationName": "string",
      // end of the list of possible fields
      // Includes only one of the fields `impersonatorFederationType`
      "impersonatorFederationType": "string"
      // end of the list of possible fields
    }
  },
  "authorization": {
    "authorized": "boolean"
  },
  "resourceMetadata": {
    "path": [
      {
        "resourceType": "string",
        "resourceId": "string",
        // Includes only one of the fields `resourceName`
        "resourceName": "string"
        // end of the list of possible fields
      }
    ]
  },
  "requestMetadata": {
    "remoteAddress": "string",
    "userAgent": "string",
    "requestId": "string",
    // Includes only one of the fields `remotePort`
    "remotePort": "string"
    // end of the list of possible fields
  },
  "eventStatus": "string",
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "details": {
    "clusterId": "string",
    "clusterName": "string",
    "cluster": {
      "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": {
              "backgroundPoolSize": "string",
              "backgroundMergesMutationsConcurrencyRatio": "string",
              "backgroundSchedulePoolSize": "string",
              "backgroundFetchesPoolSize": "string",
              "backgroundMovePoolSize": "string",
              "backgroundDistributedSchedulePoolSize": "string",
              "backgroundBufferFlushSchedulePoolSize": "string",
              "backgroundMessageBrokerSchedulePoolSize": "string",
              "backgroundCommonPoolSize": "string",
              "dictionariesLazyLoad": "boolean",
              "logLevel": "string",
              "queryLogRetentionSize": "string",
              "queryLogRetentionTime": "string",
              "queryThreadLogEnabled": "boolean",
              "queryThreadLogRetentionSize": "string",
              "queryThreadLogRetentionTime": "string",
              "partLogRetentionSize": "string",
              "partLogRetentionTime": "string",
              "metricLogEnabled": "boolean",
              "metricLogRetentionSize": "string",
              "metricLogRetentionTime": "string",
              "traceLogEnabled": "boolean",
              "traceLogRetentionSize": "string",
              "traceLogRetentionTime": "string",
              "textLogEnabled": "boolean",
              "textLogRetentionSize": "string",
              "textLogRetentionTime": "string",
              "textLogLevel": "string",
              "opentelemetrySpanLogEnabled": "boolean",
              "opentelemetrySpanLogRetentionSize": "string",
              "opentelemetrySpanLogRetentionTime": "string",
              "queryViewsLogEnabled": "boolean",
              "queryViewsLogRetentionSize": "string",
              "queryViewsLogRetentionTime": "string",
              "asynchronousMetricLogEnabled": "boolean",
              "asynchronousMetricLogRetentionSize": "string",
              "asynchronousMetricLogRetentionTime": "string",
              "sessionLogEnabled": "boolean",
              "sessionLogRetentionSize": "string",
              "sessionLogRetentionTime": "string",
              "zookeeperLogEnabled": "boolean",
              "zookeeperLogRetentionSize": "string",
              "zookeeperLogRetentionTime": "string",
              "asynchronousInsertLogEnabled": "boolean",
              "asynchronousInsertLogRetentionSize": "string",
              "asynchronousInsertLogRetentionTime": "string",
              "processorsProfileLogEnabled": "boolean",
              "processorsProfileLogRetentionSize": "string",
              "processorsProfileLogRetentionTime": "string",
              "errorLogEnabled": "boolean",
              "errorLogRetentionSize": "string",
              "errorLogRetentionTime": "string",
              "queryMetricLogEnabled": "boolean",
              "queryMetricLogRetentionSize": "string",
              "queryMetricLogRetentionTime": "string",
              "accessControlImprovements": {
                "selectFromSystemDbRequiresGrant": "boolean",
                "selectFromInformationSchemaRequiresGrant": "boolean"
              },
              "maxConnections": "string",
              "maxConcurrentQueries": "string",
              "maxTableSizeToDrop": "string",
              "maxPartitionSizeToDrop": "string",
              "keepAliveTimeout": "string",
              "uncompressedCacheSize": "string",
              "markCacheSize": "string",
              "timezone": "string",
              "geobaseEnabled": "boolean",
              "geobaseUri": "string",
              "defaultDatabase": "string",
              "totalMemoryProfilerStep": "string",
              "totalMemoryTrackerSampleProbability": "number",
              "asyncInsertThreads": "string",
              "backupThreads": "string",
              "restoreThreads": "string",
              "vectorSimilarityIndexCacheSize": "string",
              "vectorSimilarityIndexCacheMaxEntries": "string",
              "maxBuildVectorSimilarityIndexThreadPoolSize": "string",
              "mergeTree": {
                "partsToDelayInsert": "string",
                "partsToThrowInsert": "string",
                "inactivePartsToDelayInsert": "string",
                "inactivePartsToThrowInsert": "string",
                "maxAvgPartSizeForTooManyParts": "string",
                "maxPartsInTotal": "string",
                "maxReplicatedMergesInQueue": "string",
                "numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "string",
                "numberOfFreeEntriesInPoolToExecuteMutation": "string",
                "numberOfFreeEntriesInPoolToExecuteOptimizeEntirePartition": "string",
                "maxBytesToMergeAtMinSpaceInPool": "string",
                "maxBytesToMergeAtMaxSpaceInPool": "string",
                "minBytesForWidePart": "string",
                "minRowsForWidePart": "string",
                "cleanupDelayPeriod": "string",
                "maxCleanupDelayPeriod": "string",
                "mergeSelectingSleepMs": "string",
                "maxMergeSelectingSleepMs": "string",
                "minAgeToForceMergeSeconds": "string",
                "minAgeToForceMergeOnPartitionOnly": "boolean",
                "mergeMaxBlockSize": "string",
                "deduplicateMergeProjectionMode": "string",
                "lightweightMutationProjectionMode": "string",
                "replicatedDeduplicationWindow": "string",
                "replicatedDeduplicationWindowSeconds": "string",
                "fsyncAfterInsert": "boolean",
                "fsyncPartDirectory": "boolean",
                "minCompressedBytesToFsyncAfterFetch": "string",
                "minCompressedBytesToFsyncAfterMerge": "string",
                "minRowsToFsyncAfterMerge": "string",
                "ttlOnlyDropParts": "boolean",
                "mergeWithTtlTimeout": "string",
                "mergeWithRecompressionTtlTimeout": "string",
                "maxNumberOfMergesWithTtlInPool": "string",
                "materializeTtlRecalculateOnly": "boolean",
                "checkSampleColumnIsCorrect": "boolean",
                "allowRemoteFsZeroCopyReplication": "boolean"
              },
              "compression": [
                {
                  "method": "string",
                  "minPartSize": "string",
                  "minPartSizeRatio": "string",
                  "level": "string"
                }
              ],
              "dictionaries": [
                {
                  "name": "string",
                  "structure": {
                    "id": {
                      "name": "string"
                    },
                    "key": {
                      "attributes": [
                        {
                          "name": "string",
                          "type": "string",
                          "nullValue": "string",
                          "expression": "string",
                          "hierarchical": "boolean",
                          "injective": "boolean"
                        }
                      ]
                    },
                    "rangeMin": {
                      "name": "string",
                      "type": "string",
                      "nullValue": "string",
                      "expression": "string",
                      "hierarchical": "boolean",
                      "injective": "boolean"
                    },
                    "rangeMax": {
                      "name": "string",
                      "type": "string",
                      "nullValue": "string",
                      "expression": "string",
                      "hierarchical": "boolean",
                      "injective": "boolean"
                    },
                    "attributes": [
                      {
                        "name": "string",
                        "type": "string",
                        "nullValue": "string",
                        "expression": "string",
                        "hierarchical": "boolean",
                        "injective": "boolean"
                      }
                    ]
                  },
                  "layout": {
                    "type": "string",
                    "sizeInCells": "string",
                    "allowReadExpiredKeys": "boolean",
                    "maxUpdateQueueSize": "string",
                    "updateQueuePushTimeoutMilliseconds": "string",
                    "queryWaitTimeoutMilliseconds": "string",
                    "maxThreadsForUpdates": "string",
                    "initialArraySize": "string",
                    "maxArraySize": "string",
                    "accessToKeyFromAttributes": "boolean"
                  },
                  // Includes only one of the fields `fixedLifetime`, `lifetimeRange`
                  "fixedLifetime": "string",
                  "lifetimeRange": {
                    "min": "string",
                    "max": "string"
                  },
                  // end of the list of possible fields
                  // Includes only one of the fields `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
                  "httpSource": {
                    "url": "string",
                    "format": "string",
                    "headers": [
                      {
                        "name": "string",
                        "value": "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",
                    "closeConnection": "boolean",
                    "shareConnection": "boolean"
                  },
                  "clickhouseSource": {
                    "db": "string",
                    "table": "string",
                    "host": "string",
                    "port": "string",
                    "user": "string",
                    "password": "string",
                    "where": "string",
                    "secure": "boolean"
                  },
                  "mongodbSource": {
                    "db": "string",
                    "collection": "string",
                    "host": "string",
                    "port": "string",
                    "user": "string",
                    "password": "string",
                    "options": "string"
                  },
                  "postgresqlSource": {
                    "db": "string",
                    "table": "string",
                    "hosts": [
                      "string"
                    ],
                    "port": "string",
                    "user": "string",
                    "password": "string",
                    "invalidateQuery": "string",
                    "sslMode": "string"
                  }
                  // end of the list of possible fields
                }
              ],
              "graphiteRollup": [
                {
                  "name": "string",
                  "patterns": [
                    {
                      "regexp": "string",
                      "function": "string",
                      "retention": [
                        {
                          "age": "string",
                          "precision": "string"
                        }
                      ]
                    }
                  ],
                  "pathColumnName": "string",
                  "timeColumnName": "string",
                  "valueColumnName": "string",
                  "versionColumnName": "string"
                }
              ],
              "kafka": {
                "securityProtocol": "string",
                "saslMechanism": "string",
                "saslUsername": "string",
                "saslPassword": "string",
                "enableSslCertificateVerification": "boolean",
                "maxPollIntervalMs": "string",
                "sessionTimeoutMs": "string",
                "debug": "string",
                "autoOffsetReset": "string",
                "messageMaxBytes": "string",
                "batchSize": "string"
              },
              "kafkaTopics": [
                {
                  "name": "string",
                  "settings": {
                    "securityProtocol": "string",
                    "saslMechanism": "string",
                    "saslUsername": "string",
                    "saslPassword": "string",
                    "enableSslCertificateVerification": "boolean",
                    "maxPollIntervalMs": "string",
                    "sessionTimeoutMs": "string",
                    "debug": "string",
                    "autoOffsetReset": "string",
                    "messageMaxBytes": "string",
                    "batchSize": "string"
                  }
                }
              ],
              "rabbitmq": {
                "username": "string",
                "password": "string",
                "vhost": "string"
              },
              "queryMaskingRules": [
                {
                  "name": "string",
                  "regexp": "string",
                  "replace": "string"
                }
              ],
              "queryCache": {
                "maxSizeInBytes": "string",
                "maxEntries": "string",
                "maxEntrySizeInBytes": "string",
                "maxEntrySizeInRows": "string"
              },
              "jdbcBridge": {
                "host": "string",
                "port": "string"
              },
              "mysqlProtocol": "boolean",
              "customMacros": [
                {
                  "name": "string",
                  "value": "string"
                }
              ],
              "builtinDictionariesReloadInterval": "string"
            },
            "userConfig": {
              "backgroundPoolSize": "string",
              "backgroundMergesMutationsConcurrencyRatio": "string",
              "backgroundSchedulePoolSize": "string",
              "backgroundFetchesPoolSize": "string",
              "backgroundMovePoolSize": "string",
              "backgroundDistributedSchedulePoolSize": "string",
              "backgroundBufferFlushSchedulePoolSize": "string",
              "backgroundMessageBrokerSchedulePoolSize": "string",
              "backgroundCommonPoolSize": "string",
              "dictionariesLazyLoad": "boolean",
              "logLevel": "string",
              "queryLogRetentionSize": "string",
              "queryLogRetentionTime": "string",
              "queryThreadLogEnabled": "boolean",
              "queryThreadLogRetentionSize": "string",
              "queryThreadLogRetentionTime": "string",
              "partLogRetentionSize": "string",
              "partLogRetentionTime": "string",
              "metricLogEnabled": "boolean",
              "metricLogRetentionSize": "string",
              "metricLogRetentionTime": "string",
              "traceLogEnabled": "boolean",
              "traceLogRetentionSize": "string",
              "traceLogRetentionTime": "string",
              "textLogEnabled": "boolean",
              "textLogRetentionSize": "string",
              "textLogRetentionTime": "string",
              "textLogLevel": "string",
              "opentelemetrySpanLogEnabled": "boolean",
              "opentelemetrySpanLogRetentionSize": "string",
              "opentelemetrySpanLogRetentionTime": "string",
              "queryViewsLogEnabled": "boolean",
              "queryViewsLogRetentionSize": "string",
              "queryViewsLogRetentionTime": "string",
              "asynchronousMetricLogEnabled": "boolean",
              "asynchronousMetricLogRetentionSize": "string",
              "asynchronousMetricLogRetentionTime": "string",
              "sessionLogEnabled": "boolean",
              "sessionLogRetentionSize": "string",
              "sessionLogRetentionTime": "string",
              "zookeeperLogEnabled": "boolean",
              "zookeeperLogRetentionSize": "string",
              "zookeeperLogRetentionTime": "string",
              "asynchronousInsertLogEnabled": "boolean",
              "asynchronousInsertLogRetentionSize": "string",
              "asynchronousInsertLogRetentionTime": "string",
              "processorsProfileLogEnabled": "boolean",
              "processorsProfileLogRetentionSize": "string",
              "processorsProfileLogRetentionTime": "string",
              "errorLogEnabled": "boolean",
              "errorLogRetentionSize": "string",
              "errorLogRetentionTime": "string",
              "queryMetricLogEnabled": "boolean",
              "queryMetricLogRetentionSize": "string",
              "queryMetricLogRetentionTime": "string",
              "accessControlImprovements": {
                "selectFromSystemDbRequiresGrant": "boolean",
                "selectFromInformationSchemaRequiresGrant": "boolean"
              },
              "maxConnections": "string",
              "maxConcurrentQueries": "string",
              "maxTableSizeToDrop": "string",
              "maxPartitionSizeToDrop": "string",
              "keepAliveTimeout": "string",
              "uncompressedCacheSize": "string",
              "markCacheSize": "string",
              "timezone": "string",
              "geobaseEnabled": "boolean",
              "geobaseUri": "string",
              "defaultDatabase": "string",
              "totalMemoryProfilerStep": "string",
              "totalMemoryTrackerSampleProbability": "number",
              "asyncInsertThreads": "string",
              "backupThreads": "string",
              "restoreThreads": "string",
              "vectorSimilarityIndexCacheSize": "string",
              "vectorSimilarityIndexCacheMaxEntries": "string",
              "maxBuildVectorSimilarityIndexThreadPoolSize": "string",
              "mergeTree": {
                "partsToDelayInsert": "string",
                "partsToThrowInsert": "string",
                "inactivePartsToDelayInsert": "string",
                "inactivePartsToThrowInsert": "string",
                "maxAvgPartSizeForTooManyParts": "string",
                "maxPartsInTotal": "string",
                "maxReplicatedMergesInQueue": "string",
                "numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "string",
                "numberOfFreeEntriesInPoolToExecuteMutation": "string",
                "numberOfFreeEntriesInPoolToExecuteOptimizeEntirePartition": "string",
                "maxBytesToMergeAtMinSpaceInPool": "string",
                "maxBytesToMergeAtMaxSpaceInPool": "string",
                "minBytesForWidePart": "string",
                "minRowsForWidePart": "string",
                "cleanupDelayPeriod": "string",
                "maxCleanupDelayPeriod": "string",
                "mergeSelectingSleepMs": "string",
                "maxMergeSelectingSleepMs": "string",
                "minAgeToForceMergeSeconds": "string",
                "minAgeToForceMergeOnPartitionOnly": "boolean",
                "mergeMaxBlockSize": "string",
                "deduplicateMergeProjectionMode": "string",
                "lightweightMutationProjectionMode": "string",
                "replicatedDeduplicationWindow": "string",
                "replicatedDeduplicationWindowSeconds": "string",
                "fsyncAfterInsert": "boolean",
                "fsyncPartDirectory": "boolean",
                "minCompressedBytesToFsyncAfterFetch": "string",
                "minCompressedBytesToFsyncAfterMerge": "string",
                "minRowsToFsyncAfterMerge": "string",
                "ttlOnlyDropParts": "boolean",
                "mergeWithTtlTimeout": "string",
                "mergeWithRecompressionTtlTimeout": "string",
                "maxNumberOfMergesWithTtlInPool": "string",
                "materializeTtlRecalculateOnly": "boolean",
                "checkSampleColumnIsCorrect": "boolean",
                "allowRemoteFsZeroCopyReplication": "boolean"
              },
              "compression": [
                {
                  "method": "string",
                  "minPartSize": "string",
                  "minPartSizeRatio": "string",
                  "level": "string"
                }
              ],
              "dictionaries": [
                {
                  "name": "string",
                  "structure": {
                    "id": {
                      "name": "string"
                    },
                    "key": {
                      "attributes": [
                        {
                          "name": "string",
                          "type": "string",
                          "nullValue": "string",
                          "expression": "string",
                          "hierarchical": "boolean",
                          "injective": "boolean"
                        }
                      ]
                    },
                    "rangeMin": {
                      "name": "string",
                      "type": "string",
                      "nullValue": "string",
                      "expression": "string",
                      "hierarchical": "boolean",
                      "injective": "boolean"
                    },
                    "rangeMax": {
                      "name": "string",
                      "type": "string",
                      "nullValue": "string",
                      "expression": "string",
                      "hierarchical": "boolean",
                      "injective": "boolean"
                    },
                    "attributes": [
                      {
                        "name": "string",
                        "type": "string",
                        "nullValue": "string",
                        "expression": "string",
                        "hierarchical": "boolean",
                        "injective": "boolean"
                      }
                    ]
                  },
                  "layout": {
                    "type": "string",
                    "sizeInCells": "string",
                    "allowReadExpiredKeys": "boolean",
                    "maxUpdateQueueSize": "string",
                    "updateQueuePushTimeoutMilliseconds": "string",
                    "queryWaitTimeoutMilliseconds": "string",
                    "maxThreadsForUpdates": "string",
                    "initialArraySize": "string",
                    "maxArraySize": "string",
                    "accessToKeyFromAttributes": "boolean"
                  },
                  // Includes only one of the fields `fixedLifetime`, `lifetimeRange`
                  "fixedLifetime": "string",
                  "lifetimeRange": {
                    "min": "string",
                    "max": "string"
                  },
                  // end of the list of possible fields
                  // Includes only one of the fields `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
                  "httpSource": {
                    "url": "string",
                    "format": "string",
                    "headers": [
                      {
                        "name": "string",
                        "value": "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",
                    "closeConnection": "boolean",
                    "shareConnection": "boolean"
                  },
                  "clickhouseSource": {
                    "db": "string",
                    "table": "string",
                    "host": "string",
                    "port": "string",
                    "user": "string",
                    "password": "string",
                    "where": "string",
                    "secure": "boolean"
                  },
                  "mongodbSource": {
                    "db": "string",
                    "collection": "string",
                    "host": "string",
                    "port": "string",
                    "user": "string",
                    "password": "string",
                    "options": "string"
                  },
                  "postgresqlSource": {
                    "db": "string",
                    "table": "string",
                    "hosts": [
                      "string"
                    ],
                    "port": "string",
                    "user": "string",
                    "password": "string",
                    "invalidateQuery": "string",
                    "sslMode": "string"
                  }
                  // end of the list of possible fields
                }
              ],
              "graphiteRollup": [
                {
                  "name": "string",
                  "patterns": [
                    {
                      "regexp": "string",
                      "function": "string",
                      "retention": [
                        {
                          "age": "string",
                          "precision": "string"
                        }
                      ]
                    }
                  ],
                  "pathColumnName": "string",
                  "timeColumnName": "string",
                  "valueColumnName": "string",
                  "versionColumnName": "string"
                }
              ],
              "kafka": {
                "securityProtocol": "string",
                "saslMechanism": "string",
                "saslUsername": "string",
                "saslPassword": "string",
                "enableSslCertificateVerification": "boolean",
                "maxPollIntervalMs": "string",
                "sessionTimeoutMs": "string",
                "debug": "string",
                "autoOffsetReset": "string",
                "messageMaxBytes": "string",
                "batchSize": "string"
              },
              "kafkaTopics": [
                {
                  "name": "string",
                  "settings": {
                    "securityProtocol": "string",
                    "saslMechanism": "string",
                    "saslUsername": "string",
                    "saslPassword": "string",
                    "enableSslCertificateVerification": "boolean",
                    "maxPollIntervalMs": "string",
                    "sessionTimeoutMs": "string",
                    "debug": "string",
                    "autoOffsetReset": "string",
                    "messageMaxBytes": "string",
                    "batchSize": "string"
                  }
                }
              ],
              "rabbitmq": {
                "username": "string",
                "password": "string",
                "vhost": "string"
              },
              "queryMaskingRules": [
                {
                  "name": "string",
                  "regexp": "string",
                  "replace": "string"
                }
              ],
              "queryCache": {
                "maxSizeInBytes": "string",
                "maxEntries": "string",
                "maxEntrySizeInBytes": "string",
                "maxEntrySizeInRows": "string"
              },
              "jdbcBridge": {
                "host": "string",
                "port": "string"
              },
              "mysqlProtocol": "boolean",
              "customMacros": [
                {
                  "name": "string",
                  "value": "string"
                }
              ],
              "builtinDictionariesReloadInterval": "string"
            },
            "defaultConfig": {
              "backgroundPoolSize": "string",
              "backgroundMergesMutationsConcurrencyRatio": "string",
              "backgroundSchedulePoolSize": "string",
              "backgroundFetchesPoolSize": "string",
              "backgroundMovePoolSize": "string",
              "backgroundDistributedSchedulePoolSize": "string",
              "backgroundBufferFlushSchedulePoolSize": "string",
              "backgroundMessageBrokerSchedulePoolSize": "string",
              "backgroundCommonPoolSize": "string",
              "dictionariesLazyLoad": "boolean",
              "logLevel": "string",
              "queryLogRetentionSize": "string",
              "queryLogRetentionTime": "string",
              "queryThreadLogEnabled": "boolean",
              "queryThreadLogRetentionSize": "string",
              "queryThreadLogRetentionTime": "string",
              "partLogRetentionSize": "string",
              "partLogRetentionTime": "string",
              "metricLogEnabled": "boolean",
              "metricLogRetentionSize": "string",
              "metricLogRetentionTime": "string",
              "traceLogEnabled": "boolean",
              "traceLogRetentionSize": "string",
              "traceLogRetentionTime": "string",
              "textLogEnabled": "boolean",
              "textLogRetentionSize": "string",
              "textLogRetentionTime": "string",
              "textLogLevel": "string",
              "opentelemetrySpanLogEnabled": "boolean",
              "opentelemetrySpanLogRetentionSize": "string",
              "opentelemetrySpanLogRetentionTime": "string",
              "queryViewsLogEnabled": "boolean",
              "queryViewsLogRetentionSize": "string",
              "queryViewsLogRetentionTime": "string",
              "asynchronousMetricLogEnabled": "boolean",
              "asynchronousMetricLogRetentionSize": "string",
              "asynchronousMetricLogRetentionTime": "string",
              "sessionLogEnabled": "boolean",
              "sessionLogRetentionSize": "string",
              "sessionLogRetentionTime": "string",
              "zookeeperLogEnabled": "boolean",
              "zookeeperLogRetentionSize": "string",
              "zookeeperLogRetentionTime": "string",
              "asynchronousInsertLogEnabled": "boolean",
              "asynchronousInsertLogRetentionSize": "string",
              "asynchronousInsertLogRetentionTime": "string",
              "processorsProfileLogEnabled": "boolean",
              "processorsProfileLogRetentionSize": "string",
              "processorsProfileLogRetentionTime": "string",
              "errorLogEnabled": "boolean",
              "errorLogRetentionSize": "string",
              "errorLogRetentionTime": "string",
              "queryMetricLogEnabled": "boolean",
              "queryMetricLogRetentionSize": "string",
              "queryMetricLogRetentionTime": "string",
              "accessControlImprovements": {
                "selectFromSystemDbRequiresGrant": "boolean",
                "selectFromInformationSchemaRequiresGrant": "boolean"
              },
              "maxConnections": "string",
              "maxConcurrentQueries": "string",
              "maxTableSizeToDrop": "string",
              "maxPartitionSizeToDrop": "string",
              "keepAliveTimeout": "string",
              "uncompressedCacheSize": "string",
              "markCacheSize": "string",
              "timezone": "string",
              "geobaseEnabled": "boolean",
              "geobaseUri": "string",
              "defaultDatabase": "string",
              "totalMemoryProfilerStep": "string",
              "totalMemoryTrackerSampleProbability": "number",
              "asyncInsertThreads": "string",
              "backupThreads": "string",
              "restoreThreads": "string",
              "vectorSimilarityIndexCacheSize": "string",
              "vectorSimilarityIndexCacheMaxEntries": "string",
              "maxBuildVectorSimilarityIndexThreadPoolSize": "string",
              "mergeTree": {
                "partsToDelayInsert": "string",
                "partsToThrowInsert": "string",
                "inactivePartsToDelayInsert": "string",
                "inactivePartsToThrowInsert": "string",
                "maxAvgPartSizeForTooManyParts": "string",
                "maxPartsInTotal": "string",
                "maxReplicatedMergesInQueue": "string",
                "numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge": "string",
                "numberOfFreeEntriesInPoolToExecuteMutation": "string",
                "numberOfFreeEntriesInPoolToExecuteOptimizeEntirePartition": "string",
                "maxBytesToMergeAtMinSpaceInPool": "string",
                "maxBytesToMergeAtMaxSpaceInPool": "string",
                "minBytesForWidePart": "string",
                "minRowsForWidePart": "string",
                "cleanupDelayPeriod": "string",
                "maxCleanupDelayPeriod": "string",
                "mergeSelectingSleepMs": "string",
                "maxMergeSelectingSleepMs": "string",
                "minAgeToForceMergeSeconds": "string",
                "minAgeToForceMergeOnPartitionOnly": "boolean",
                "mergeMaxBlockSize": "string",
                "deduplicateMergeProjectionMode": "string",
                "lightweightMutationProjectionMode": "string",
                "replicatedDeduplicationWindow": "string",
                "replicatedDeduplicationWindowSeconds": "string",
                "fsyncAfterInsert": "boolean",
                "fsyncPartDirectory": "boolean",
                "minCompressedBytesToFsyncAfterFetch": "string",
                "minCompressedBytesToFsyncAfterMerge": "string",
                "minRowsToFsyncAfterMerge": "string",
                "ttlOnlyDropParts": "boolean",
                "mergeWithTtlTimeout": "string",
                "mergeWithRecompressionTtlTimeout": "string",
                "maxNumberOfMergesWithTtlInPool": "string",
                "materializeTtlRecalculateOnly": "boolean",
                "checkSampleColumnIsCorrect": "boolean",
                "allowRemoteFsZeroCopyReplication": "boolean"
              },
              "compression": [
                {
                  "method": "string",
                  "minPartSize": "string",
                  "minPartSizeRatio": "string",
                  "level": "string"
                }
              ],
              "dictionaries": [
                {
                  "name": "string",
                  "structure": {
                    "id": {
                      "name": "string"
                    },
                    "key": {
                      "attributes": [
                        {
                          "name": "string",
                          "type": "string",
                          "nullValue": "string",
                          "expression": "string",
                          "hierarchical": "boolean",
                          "injective": "boolean"
                        }
                      ]
                    },
                    "rangeMin": {
                      "name": "string",
                      "type": "string",
                      "nullValue": "string",
                      "expression": "string",
                      "hierarchical": "boolean",
                      "injective": "boolean"
                    },
                    "rangeMax": {
                      "name": "string",
                      "type": "string",
                      "nullValue": "string",
                      "expression": "string",
                      "hierarchical": "boolean",
                      "injective": "boolean"
                    },
                    "attributes": [
                      {
                        "name": "string",
                        "type": "string",
                        "nullValue": "string",
                        "expression": "string",
                        "hierarchical": "boolean",
                        "injective": "boolean"
                      }
                    ]
                  },
                  "layout": {
                    "type": "string",
                    "sizeInCells": "string",
                    "allowReadExpiredKeys": "boolean",
                    "maxUpdateQueueSize": "string",
                    "updateQueuePushTimeoutMilliseconds": "string",
                    "queryWaitTimeoutMilliseconds": "string",
                    "maxThreadsForUpdates": "string",
                    "initialArraySize": "string",
                    "maxArraySize": "string",
                    "accessToKeyFromAttributes": "boolean"
                  },
                  // Includes only one of the fields `fixedLifetime`, `lifetimeRange`
                  "fixedLifetime": "string",
                  "lifetimeRange": {
                    "min": "string",
                    "max": "string"
                  },
                  // end of the list of possible fields
                  // Includes only one of the fields `httpSource`, `mysqlSource`, `clickhouseSource`, `mongodbSource`, `postgresqlSource`
                  "httpSource": {
                    "url": "string",
                    "format": "string",
                    "headers": [
                      {
                        "name": "string",
                        "value": "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",
                    "closeConnection": "boolean",
                    "shareConnection": "boolean"
                  },
                  "clickhouseSource": {
                    "db": "string",
                    "table": "string",
                    "host": "string",
                    "port": "string",
                    "user": "string",
                    "password": "string",
                    "where": "string",
                    "secure": "boolean"
                  },
                  "mongodbSource": {
                    "db": "string",
                    "collection": "string",
                    "host": "string",
                    "port": "string",
                    "user": "string",
                    "password": "string",
                    "options": "string"
                  },
                  "postgresqlSource": {
                    "db": "string",
                    "table": "string",
                    "hosts": [
                      "string"
                    ],
                    "port": "string",
                    "user": "string",
                    "password": "string",
                    "invalidateQuery": "string",
                    "sslMode": "string"
                  }
                  // end of the list of possible fields
                }
              ],
              "graphiteRollup": [
                {
                  "name": "string",
                  "patterns": [
                    {
                      "regexp": "string",
                      "function": "string",
                      "retention": [
                        {
                          "age": "string",
                          "precision": "string"
                        }
                      ]
                    }
                  ],
                  "pathColumnName": "string",
                  "timeColumnName": "string",
                  "valueColumnName": "string",
                  "versionColumnName": "string"
                }
              ],
              "kafka": {
                "securityProtocol": "string",
                "saslMechanism": "string",
                "saslUsername": "string",
                "saslPassword": "string",
                "enableSslCertificateVerification": "boolean",
                "maxPollIntervalMs": "string",
                "sessionTimeoutMs": "string",
                "debug": "string",
                "autoOffsetReset": "string",
                "messageMaxBytes": "string",
                "batchSize": "string"
              },
              "kafkaTopics": [
                {
                  "name": "string",
                  "settings": {
                    "securityProtocol": "string",
                    "saslMechanism": "string",
                    "saslUsername": "string",
                    "saslPassword": "string",
                    "enableSslCertificateVerification": "boolean",
                    "maxPollIntervalMs": "string",
                    "sessionTimeoutMs": "string",
                    "debug": "string",
                    "autoOffsetReset": "string",
                    "messageMaxBytes": "string",
                    "batchSize": "string"
                  }
                }
              ],
              "rabbitmq": {
                "username": "string",
                "password": "string",
                "vhost": "string"
              },
              "queryMaskingRules": [
                {
                  "name": "string",
                  "regexp": "string",
                  "replace": "string"
                }
              ],
              "queryCache": {
                "maxSizeInBytes": "string",
                "maxEntries": "string",
                "maxEntrySizeInBytes": "string",
                "maxEntrySizeInRows": "string"
              },
              "jdbcBridge": {
                "host": "string",
                "port": "string"
              },
              "mysqlProtocol": "boolean",
              "customMacros": [
                {
                  "name": "string",
                  "value": "string"
                }
              ],
              "builtinDictionariesReloadInterval": "string"
            }
          },
          "resources": {
            "resourcePresetId": "string",
            "diskSize": "string",
            "diskTypeId": "string"
          },
          "diskSizeAutoscaling": {
            "plannedUsageThreshold": "string",
            "emergencyUsageThreshold": "string",
            "diskSizeLimit": "string"
          }
        },
        "zookeeper": {
          "resources": {
            "resourcePresetId": "string",
            "diskSize": "string",
            "diskTypeId": "string"
          },
          "diskSizeAutoscaling": {
            "plannedUsageThreshold": "string",
            "emergencyUsageThreshold": "string",
            "diskSizeLimit": "string"
          }
        },
        "backupWindowStart": {
          "hours": "integer",
          "minutes": "integer",
          "seconds": "integer",
          "nanos": "integer"
        },
        "access": {
          "dataLens": "boolean",
          "webSql": "boolean",
          "metrika": "boolean",
          "serverless": "boolean",
          "dataTransfer": "boolean",
          "yandexQuery": "boolean"
        },
        "cloudStorage": {
          "enabled": "boolean",
          "moveFactor": "number",
          "dataCacheEnabled": "boolean",
          "dataCacheMaxSize": "string",
          "preferNotToMerge": "boolean"
        },
        "sqlDatabaseManagement": "boolean",
        "sqlUserManagement": "boolean",
        "embeddedKeeper": "boolean",
        "backupRetainPeriodDays": "string",
        "fullVersion": "string",
        "performanceDiagnostics": {
          "enabled": "boolean",
          "processesRefreshInterval": "string"
        }
      },
      "networkId": "string",
      "health": "string",
      "status": "string",
      "serviceAccountId": "string",
      "maintenanceWindow": {
        // Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
        "anytime": "object",
        "weeklyMaintenanceWindow": {
          "day": "string",
          "hour": "string"
        }
        // end of the list of possible fields
      },
      "plannedOperation": {
        "info": "string",
        "delayedUntil": "string"
      },
      "securityGroupIds": [
        "string"
      ],
      "deletionProtection": "boolean",
      "diskEncryptionKeyId": "string"
    },
    "hosts": [
      {
        "name": "string",
        "clusterId": "string",
        "zoneId": "string",
        "type": "string",
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "services": [
          {
            "type": "string",
            "health": "string"
          }
        ],
        "subnetId": "string",
        "assignPublicIp": "boolean",
        "shardName": "string",
        "internalIpv4": [
          "string"
        ]
      }
    ],
    "databases": [
      {
        "name": "string",
        "clusterId": "string",
        "engine": "string"
      }
    ],
    "users": [
      {
        "name": "string",
        "clusterId": "string",
        "permissions": [
          {
            "databaseName": "string"
          }
        ],
        "settings": {
          "readonly": "string",
          "allowDdl": "boolean",
          "allowIntrospectionFunctions": "boolean",
          "connectTimeout": "string",
          "connectTimeoutWithFailover": "string",
          "receiveTimeout": "string",
          "sendTimeout": "string",
          "idleConnectionTimeout": "string",
          "timeoutBeforeCheckingExecutionSpeed": "string",
          "insertQuorum": "string",
          "insertQuorumTimeout": "string",
          "insertQuorumParallel": "boolean",
          "selectSequentialConsistency": "boolean",
          "replicationAlterPartitionsSync": "string",
          "maxReplicaDelayForDistributedQueries": "string",
          "fallbackToStaleReplicasForDistributedQueries": "boolean",
          "distributedProductMode": "string",
          "distributedAggregationMemoryEfficient": "boolean",
          "distributedDdlTaskTimeout": "string",
          "distributedDdlOutputMode": "string",
          "skipUnavailableShards": "boolean",
          "useHedgedRequests": "boolean",
          "hedgedConnectionTimeoutMs": "string",
          "loadBalancing": "string",
          "preferLocalhostReplica": "boolean",
          "compileExpressions": "boolean",
          "minCountToCompileExpression": "string",
          "maxBlockSize": "string",
          "minInsertBlockSizeRows": "string",
          "minInsertBlockSizeBytes": "string",
          "maxInsertBlockSize": "string",
          "maxPartitionsPerInsertBlock": "string",
          "minBytesToUseDirectIo": "string",
          "useUncompressedCache": "boolean",
          "mergeTreeMaxRowsToUseCache": "string",
          "mergeTreeMaxBytesToUseCache": "string",
          "mergeTreeMinRowsForConcurrentRead": "string",
          "mergeTreeMinBytesForConcurrentRead": "string",
          "maxBytesBeforeExternalGroupBy": "string",
          "maxBytesBeforeExternalSort": "string",
          "groupByTwoLevelThreshold": "string",
          "groupByTwoLevelThresholdBytes": "string",
          "deduplicateBlocksInDependentMaterializedViews": "boolean",
          "localFilesystemReadMethod": "string",
          "remoteFilesystemReadMethod": "string",
          "priority": "string",
          "maxThreads": "string",
          "maxInsertThreads": "string",
          "maxMemoryUsage": "string",
          "maxMemoryUsageForUser": "string",
          "memoryOvercommitRatioDenominator": "string",
          "memoryOvercommitRatioDenominatorForUser": "string",
          "memoryUsageOvercommitMaxWaitMicroseconds": "string",
          "maxNetworkBandwidth": "string",
          "maxNetworkBandwidthForUser": "string",
          "maxTemporaryDataOnDiskSizeForQuery": "string",
          "maxTemporaryDataOnDiskSizeForUser": "string",
          "maxConcurrentQueriesForUser": "string",
          "forceIndexByDate": "boolean",
          "forcePrimaryKey": "boolean",
          "maxRowsToRead": "string",
          "maxBytesToRead": "string",
          "readOverflowMode": "string",
          "maxRowsToGroupBy": "string",
          "groupByOverflowMode": "string",
          "maxRowsToSort": "string",
          "maxBytesToSort": "string",
          "sortOverflowMode": "string",
          "maxResultRows": "string",
          "maxResultBytes": "string",
          "resultOverflowMode": "string",
          "maxRowsInDistinct": "string",
          "maxBytesInDistinct": "string",
          "distinctOverflowMode": "string",
          "maxRowsToTransfer": "string",
          "maxBytesToTransfer": "string",
          "transferOverflowMode": "string",
          "maxExecutionTime": "string",
          "timeoutOverflowMode": "string",
          "maxRowsInSet": "string",
          "maxBytesInSet": "string",
          "setOverflowMode": "string",
          "maxRowsInJoin": "string",
          "maxBytesInJoin": "string",
          "joinOverflowMode": "string",
          "maxColumnsToRead": "string",
          "maxTemporaryColumns": "string",
          "maxTemporaryNonConstColumns": "string",
          "maxQuerySize": "string",
          "maxAstDepth": "string",
          "maxAstElements": "string",
          "maxExpandedAstElements": "string",
          "maxParserDepth": "string",
          "minExecutionSpeed": "string",
          "minExecutionSpeedBytes": "string",
          "inputFormatValuesInterpretExpressions": "boolean",
          "inputFormatDefaultsForOmittedFields": "boolean",
          "inputFormatNullAsDefault": "boolean",
          "inputFormatWithNamesUseHeader": "boolean",
          "outputFormatJsonQuote_64bitIntegers": "boolean",
          "outputFormatJsonQuoteDenormals": "boolean",
          "dateTimeInputFormat": "string",
          "dateTimeOutputFormat": "string",
          "lowCardinalityAllowInNativeFormat": "boolean",
          "emptyResultForAggregationByEmptySet": "boolean",
          "formatRegexp": "string",
          "formatRegexpEscapingRule": "string",
          "formatRegexpSkipUnmatched": "boolean",
          "inputFormatParallelParsing": "boolean",
          "inputFormatImportNestedJson": "boolean",
          "formatAvroSchemaRegistryUrl": "string",
          "dataTypeDefaultNullable": "boolean",
          "httpConnectionTimeout": "string",
          "httpReceiveTimeout": "string",
          "httpSendTimeout": "string",
          "enableHttpCompression": "boolean",
          "sendProgressInHttpHeaders": "boolean",
          "httpHeadersProgressInterval": "string",
          "addHttpCorsHeader": "boolean",
          "cancelHttpReadonlyQueriesOnClientClose": "boolean",
          "maxHttpGetRedirects": "string",
          "httpMaxFieldNameSize": "string",
          "httpMaxFieldValueSize": "string",
          "quotaMode": "string",
          "asyncInsert": "boolean",
          "waitForAsyncInsert": "boolean",
          "waitForAsyncInsertTimeout": "string",
          "asyncInsertMaxDataSize": "string",
          "asyncInsertBusyTimeout": "string",
          "asyncInsertUseAdaptiveBusyTimeout": "boolean",
          "logQueryThreads": "boolean",
          "logQueryViews": "boolean",
          "logQueriesProbability": "number",
          "logProcessorsProfiles": "boolean",
          "useQueryCache": "boolean",
          "enableReadsFromQueryCache": "boolean",
          "enableWritesToQueryCache": "boolean",
          "queryCacheMinQueryRuns": "string",
          "queryCacheMinQueryDuration": "string",
          "queryCacheTtl": "string",
          "queryCacheMaxEntries": "string",
          "queryCacheMaxSizeInBytes": "string",
          "queryCacheTag": "string",
          "queryCacheShareBetweenUsers": "boolean",
          "queryCacheNondeterministicFunctionHandling": "string",
          "queryCacheSystemTableHandling": "string",
          "countDistinctImplementation": "string",
          "joinedSubqueryRequiresAlias": "boolean",
          "joinUseNulls": "boolean",
          "transformNullIn": "boolean",
          "insertNullAsDefault": "boolean",
          "joinAlgorithm": [
            "string"
          ],
          "anyJoinDistinctRightTableKeys": "boolean",
          "allowSuspiciousLowCardinalityTypes": "boolean",
          "flattenNested": "boolean",
          "memoryProfilerStep": "string",
          "memoryProfilerSampleProbability": "number",
          "maxFinalThreads": "string",
          "maxReadBufferSize": "string",
          "insertKeeperMaxRetries": "string",
          "doNotMergeAcrossPartitionsSelectFinal": "boolean",
          "ignoreMaterializedViewsWithDroppedTargetTable": "boolean",
          "enableAnalyzer": "boolean",
          "s3UseAdaptiveTimeouts": "boolean",
          "final": "boolean",
          "useHivePartitioning": "boolean",
          "showDataLakeCatalogsInSystemTables": "boolean",
          "compile": "boolean",
          "minCountToCompile": "string",
          "asyncInsertThreads": "string",
          "asyncInsertStaleTimeout": "string"
        },
        "quotas": [
          {
            "intervalDuration": "string",
            "queries": "string",
            "errors": "string",
            "resultRows": "string",
            "readRows": "string",
            "executionTime": "string"
          }
        ],
        "connectionManager": {
          "connectionId": "string"
        }
      }
    ]
  },
  "requestParameters": "object",
  "response": "object"
}

Field descriptionField description

Field

Description

eventId

string

eventSource

string

eventType

string

eventTime

string (date-time)

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

authentication

IamAuthentication

authorization

Authorization

resourceMetadata

ResourceMetadata

requestMetadata

RequestMetadata

eventStatus

enum (EventStatus)

  • STARTED
  • ERROR
  • DONE
  • CANCELLED
  • RUNNING

error

Status

The error result of the operation in case of failure or cancellation.

details

ClusterCreateEventDetails

requestParameters

object

response

object

IamAuthenticationIamAuthentication

Field

Description

authenticated

boolean

subjectType

enum (IamSubjectType)

Includes only one of the fields subjectType.

  • YANDEX_PASSPORT_USER_ACCOUNT
  • SERVICE_ACCOUNT
  • FEDERATED_USER_ACCOUNT
  • SSH_USER
  • KUBERNETES_USER

subjectId

string

Includes only one of the fields subjectId.

subjectName

string

Includes only one of the fields subjectName.

federationId

string

Includes only one of the fields federationId.

federationName

string

Includes only one of the fields federationName.

federationType

enum (FederationType)

Includes only one of the fields federationType.

  • GLOBAL_FEDERATION
  • PRIVATE_FEDERATION

tokenInfo

IamTokenInfo

IamTokenInfoIamTokenInfo

Field

Description

maskedIamToken

string

iamTokenId

string

Includes only one of the fields iamTokenId.

impersonatorId

string

Includes only one of the fields impersonatorId.

impersonatorType

enum (IamSubjectType)

Includes only one of the fields impersonatorType.

  • YANDEX_PASSPORT_USER_ACCOUNT
  • SERVICE_ACCOUNT
  • FEDERATED_USER_ACCOUNT
  • SSH_USER
  • KUBERNETES_USER

impersonatorName

string

Includes only one of the fields impersonatorName.

impersonatorFederationId

string

Includes only one of the fields impersonatorFederationId.

impersonatorFederationName

string

Includes only one of the fields impersonatorFederationName.

impersonatorFederationType

enum (FederationType)

Includes only one of the fields impersonatorFederationType.

  • GLOBAL_FEDERATION
  • PRIVATE_FEDERATION

AuthorizationAuthorization

Field

Description

authorized

boolean

ResourceMetadataResourceMetadata

Field

Description

path[]

Resource

ResourceResource

Field

Description

resourceType

string

resourceId

string

resourceName

string

Includes only one of the fields resourceName.

RequestMetadataRequestMetadata

Field

Description

remoteAddress

string

userAgent

string

requestId

string

remotePort

string (int64)

Includes only one of the fields remotePort.

StatusStatus

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

ClusterCreateEventDetailsClusterCreateEventDetails

Field

Description

clusterId

string

clusterName

string

cluster

Cluster

hosts[]

HostDetails

databases[]

Database

users[]

User

ClusterCluster

Field

Description

id

string

folderId

string

createdAt

string (date-time)

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

name

string

description

string

labels

object (map<string, string>)

environment

enum (Environment)

  • PRODUCTION
  • PRESTABLE

monitoring[]

Monitoring

config

ClusterConfig

networkId

string

health

enum (Health)

  • HEALTH_UNKNOWN
  • ALIVE
  • DEAD
  • DEGRADED

status

enum (Status)

  • STATUS_UNKNOWN
  • CREATING
  • RUNNING
  • ERROR
  • UPDATING
  • STOPPING
  • STOPPED
  • STARTING

serviceAccountId

string

maintenanceWindow

MaintenanceWindow

plannedOperation

MaintenanceOperation

securityGroupIds[]

string

deletionProtection

boolean

diskEncryptionKeyId

string

MonitoringMonitoring

Field

Description

name

string

description

string

link

string

ClusterConfigClusterConfig

Field

Description

version

string

clickhouse

Clickhouse

zookeeper

Zookeeper

backupWindowStart

TimeOfDay

access

Access

cloudStorage

CloudStorage

sqlDatabaseManagement

boolean

sqlUserManagement

boolean

embeddedKeeper

boolean

backupRetainPeriodDays

string (int64)

fullVersion

string

performanceDiagnostics

PerformanceDiagnostics

ClickhouseClickhouse

Field

Description

config

ClickhouseConfigSet

resources

Resources

diskSizeAutoscaling

DiskSizeAutoscaling

ClickhouseConfigSetClickhouseConfigSet

Field

Description

effectiveConfig

ClickhouseConfig

userConfig

ClickhouseConfig

defaultConfig

ClickhouseConfig

ClickhouseConfigClickhouseConfig

Field

Description

backgroundPoolSize

string (int64)

The minimum value is 1.

backgroundMergesMutationsConcurrencyRatio

string (int64)

backgroundSchedulePoolSize

string (int64)

The minimum value is 1.

backgroundFetchesPoolSize

string (int64)

The minimum value is 1.

backgroundMovePoolSize

string (int64)

The minimum value is 1.

backgroundDistributedSchedulePoolSize

string (int64)

The minimum value is 1.

backgroundBufferFlushSchedulePoolSize

string (int64)

The minimum value is 1.

backgroundMessageBrokerSchedulePoolSize

string (int64)

The minimum value is 1.

backgroundCommonPoolSize

string (int64)

The minimum value is 1.

dictionariesLazyLoad

boolean

logLevel

enum (LogLevel)

  • TRACE
  • DEBUG
  • INFORMATION
  • WARNING
  • ERROR

queryLogRetentionSize

string (int64)

The minimum value is 0.

queryLogRetentionTime

string (int64)

The minimum value is 0.

queryThreadLogEnabled

boolean

queryThreadLogRetentionSize

string (int64)

The minimum value is 0.

queryThreadLogRetentionTime

string (int64)

The minimum value is 0.

partLogRetentionSize

string (int64)

The minimum value is 0.

partLogRetentionTime

string (int64)

The minimum value is 0.

metricLogEnabled

boolean

metricLogRetentionSize

string (int64)

The minimum value is 0.

metricLogRetentionTime

string (int64)

The minimum value is 0.

traceLogEnabled

boolean

traceLogRetentionSize

string (int64)

traceLogRetentionTime

string (int64)

textLogEnabled

boolean

textLogRetentionSize

string (int64)

textLogRetentionTime

string (int64)

textLogLevel

enum (LogLevel)

  • TRACE
  • DEBUG
  • INFORMATION
  • WARNING
  • ERROR

opentelemetrySpanLogEnabled

boolean

opentelemetrySpanLogRetentionSize

string (int64)

The minimum value is 0.

opentelemetrySpanLogRetentionTime

string (int64)

The minimum value is 0.

queryViewsLogEnabled

boolean

queryViewsLogRetentionSize

string (int64)

The minimum value is 0.

queryViewsLogRetentionTime

string (int64)

The minimum value is 0.

asynchronousMetricLogEnabled

boolean

asynchronousMetricLogRetentionSize

string (int64)

The minimum value is 0.

asynchronousMetricLogRetentionTime

string (int64)

The minimum value is 0.

sessionLogEnabled

boolean

sessionLogRetentionSize

string (int64)

The minimum value is 0.

sessionLogRetentionTime

string (int64)

The minimum value is 0.

zookeeperLogEnabled

boolean

zookeeperLogRetentionSize

string (int64)

The minimum value is 0.

zookeeperLogRetentionTime

string (int64)

The minimum value is 0.

asynchronousInsertLogEnabled

boolean

asynchronousInsertLogRetentionSize

string (int64)

The minimum value is 0.

asynchronousInsertLogRetentionTime

string (int64)

The minimum value is 0.

processorsProfileLogEnabled

boolean

processorsProfileLogRetentionSize

string (int64)

The minimum value is 0.

processorsProfileLogRetentionTime

string (int64)

The minimum value is 0.

errorLogEnabled

boolean

errorLogRetentionSize

string (int64)

The minimum value is 0.

errorLogRetentionTime

string (int64)

The minimum value is 0.

queryMetricLogEnabled

boolean

queryMetricLogRetentionSize

string (int64)

The minimum value is 0.

queryMetricLogRetentionTime

string (int64)

The minimum value is 0.

accessControlImprovements

AccessControlImprovements

maxConnections

string (int64)

Acceptable values are 128 to 8192, inclusive.

maxConcurrentQueries

string (int64)

The minimum value is 100.

maxTableSizeToDrop

string (int64)

The minimum value is 0.

maxPartitionSizeToDrop

string (int64)

The minimum value is 0.

keepAliveTimeout

string (int64)

uncompressedCacheSize

string (int64)

markCacheSize

string (int64)

timezone

string

geobaseEnabled

boolean

geobaseUri

string

defaultDatabase

string

totalMemoryProfilerStep

string (int64)

totalMemoryTrackerSampleProbability

number (double)

asyncInsertThreads

string (int64)

The minimum value is 0.

backupThreads

string (int64)

restoreThreads

string (int64)

vectorSimilarityIndexCacheSize

string (int64)

The minimum value is 0.

vectorSimilarityIndexCacheMaxEntries

string (int64)

The minimum value is 0.

maxBuildVectorSimilarityIndexThreadPoolSize

string (int64)

The minimum value is 0.

mergeTree

MergeTree

compression[]

Compression

dictionaries[]

ExternalDictionary

graphiteRollup[]

GraphiteRollup

kafka

Kafka

kafkaTopics[]

KafkaTopic

rabbitmq

Rabbitmq

queryMaskingRules[]

QueryMaskingRule

queryCache

QueryCache

jdbcBridge

JdbcBridge

mysqlProtocol

boolean

customMacros[]

Macro

builtinDictionariesReloadInterval

string (int64)

AccessControlImprovementsAccessControlImprovements

Field

Description

selectFromSystemDbRequiresGrant

boolean

selectFromInformationSchemaRequiresGrant

boolean

MergeTreeMergeTree

Field

Description

partsToDelayInsert

string (int64)

partsToThrowInsert

string (int64)

inactivePartsToDelayInsert

string (int64)

The minimum value is 0.

inactivePartsToThrowInsert

string (int64)

The minimum value is 0.

maxAvgPartSizeForTooManyParts

string (int64)

The minimum value is 0.

maxPartsInTotal

string (int64)

maxReplicatedMergesInQueue

string (int64)

numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge

string (int64)

numberOfFreeEntriesInPoolToExecuteMutation

string (int64)

numberOfFreeEntriesInPoolToExecuteOptimizeEntirePartition

string (int64)

maxBytesToMergeAtMinSpaceInPool

string (int64)

maxBytesToMergeAtMaxSpaceInPool

string (int64)

The minimum value is 0.

minBytesForWidePart

string (int64)

minRowsForWidePart

string (int64)

cleanupDelayPeriod

string (int64)

The minimum value is 0.

maxCleanupDelayPeriod

string (int64)

The minimum value is 0.

mergeSelectingSleepMs

string (int64)

The minimum value is 0.

maxMergeSelectingSleepMs

string (int64)

The minimum value is 0.

minAgeToForceMergeSeconds

string (int64)

The minimum value is 0.

minAgeToForceMergeOnPartitionOnly

boolean

mergeMaxBlockSize

string (int64)

deduplicateMergeProjectionMode

enum (DeduplicateMergeProjectionMode)

  • DEDUPLICATE_MERGE_PROJECTION_MODE_IGNORE
  • DEDUPLICATE_MERGE_PROJECTION_MODE_THROW
  • DEDUPLICATE_MERGE_PROJECTION_MODE_DROP
  • DEDUPLICATE_MERGE_PROJECTION_MODE_REBUILD

lightweightMutationProjectionMode

enum (LightweightMutationProjectionMode)

  • LIGHTWEIGHT_MUTATION_PROJECTION_MODE_THROW
  • LIGHTWEIGHT_MUTATION_PROJECTION_MODE_DROP
  • LIGHTWEIGHT_MUTATION_PROJECTION_MODE_REBUILD

replicatedDeduplicationWindow

string (int64)

replicatedDeduplicationWindowSeconds

string (int64)

fsyncAfterInsert

boolean

fsyncPartDirectory

boolean

minCompressedBytesToFsyncAfterFetch

string (int64)

minCompressedBytesToFsyncAfterMerge

string (int64)

minRowsToFsyncAfterMerge

string (int64)

ttlOnlyDropParts

boolean

mergeWithTtlTimeout

string (int64)

mergeWithRecompressionTtlTimeout

string (int64)

maxNumberOfMergesWithTtlInPool

string (int64)

materializeTtlRecalculateOnly

boolean

checkSampleColumnIsCorrect

boolean

allowRemoteFsZeroCopyReplication

boolean

CompressionCompression

Field

Description

method

enum (Method)

  • LZ4
  • ZSTD
  • LZ4HC

minPartSize

string (int64)

minPartSizeRatio

string

level

string (int64)

ExternalDictionaryExternalDictionary

Field

Description

name

string

structure

Structure

layout

Layout

fixedLifetime

string (int64)

Includes only one of the fields fixedLifetime, lifetimeRange.

lifetimeRange

Range

Includes only one of the fields fixedLifetime, lifetimeRange.

httpSource

HttpSource

Includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource.

mysqlSource

MysqlSource

Includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource.

clickhouseSource

ClickhouseSource

Includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource.

mongodbSource

MongodbSource

Includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource.

postgresqlSource

PostgresqlSource

Includes only one of the fields httpSource, mysqlSource, clickhouseSource, mongodbSource, postgresqlSource.

StructureStructure

Field

Description

id

Id

key

Key

rangeMin

Attribute

rangeMax

Attribute

attributes[]

Attribute

The number of elements must be greater than 0.

IdId

Field

Description

name

string

KeyKey

Field

Description

attributes[]

Attribute

The number of elements must be greater than 0.

AttributeAttribute

Field

Description

name

string

type

string

nullValue

string

expression

string

hierarchical

boolean

injective

boolean

LayoutLayout

Field

Description

type

enum (Type)

  • FLAT
  • HASHED
  • COMPLEX_KEY_HASHED
  • RANGE_HASHED
  • CACHE
  • COMPLEX_KEY_CACHE
  • SPARSE_HASHED
  • COMPLEX_KEY_SPARSE_HASHED
  • COMPLEX_KEY_RANGE_HASHED
  • DIRECT
  • COMPLEX_KEY_DIRECT
  • IP_TRIE

sizeInCells

string (int64)

The minimum value is 0.

allowReadExpiredKeys

boolean

maxUpdateQueueSize

string (int64)

The minimum value is 0.

updateQueuePushTimeoutMilliseconds

string (int64)

The minimum value is 0.

queryWaitTimeoutMilliseconds

string (int64)

The minimum value is 0.

maxThreadsForUpdates

string (int64)

The minimum value is 0.

initialArraySize

string (int64)

The minimum value is 0.

maxArraySize

string (int64)

The minimum value is 0.

accessToKeyFromAttributes

boolean

RangeRange

Field

Description

min

string (int64)

max

string (int64)

HttpSourceHttpSource

Field

Description

url

string

format

string

headers[]

Header

HeaderHeader

Field

Description

name

string

value

string

MysqlSourceMysqlSource

Field

Description

db

string

table

string

port

string (int64)

Acceptable values are 0 to 65535, inclusive.

user

string

password

string

replicas[]

Replica

where

string

invalidateQuery

string

closeConnection

boolean

shareConnection

boolean

ReplicaReplica

Field

Description

host

string

The maximum string length in characters is 253.

priority

string (int64)

The minimum value is 0.

port

string (int64)

Acceptable values are 0 to 65535, inclusive.

user

string

password

string

ClickhouseSourceClickhouseSource

Field

Description

db

string

table

string

host

string

The maximum string length in characters is 253.

port

string (int64)

Acceptable values are 0 to 65535, inclusive.

user

string

password

string

where

string

secure

boolean

MongodbSourceMongodbSource

Field

Description

db

string

collection

string

host

string

The maximum string length in characters is 253.

port

string (int64)

Acceptable values are 0 to 65535, inclusive.

user

string

password

string

options

string

PostgresqlSourcePostgresqlSource

Field

Description

db

string

table

string

hosts[]

string

port

string (int64)

Acceptable values are 0 to 65535, inclusive.

user

string

password

string

invalidateQuery

string

sslMode

enum (SslMode)

  • DISABLE
  • ALLOW
  • PREFER
  • VERIFY_CA
  • VERIFY_FULL

GraphiteRollupGraphiteRollup

Field

Description

name

string

patterns[]

Pattern

The number of elements must be greater than 0.

pathColumnName

string

timeColumnName

string

valueColumnName

string

versionColumnName

string

PatternPattern

Field

Description

regexp

string

function

string

retention[]

Retention

RetentionRetention

Field

Description

age

string (int64)

precision

string (int64)

KafkaKafka

Field

Description

securityProtocol

enum (SecurityProtocol)

  • SECURITY_PROTOCOL_PLAINTEXT
  • SECURITY_PROTOCOL_SSL
  • SECURITY_PROTOCOL_SASL_PLAINTEXT
  • SECURITY_PROTOCOL_SASL_SSL

saslMechanism

enum (SaslMechanism)

  • SASL_MECHANISM_GSSAPI
  • SASL_MECHANISM_PLAIN
  • SASL_MECHANISM_SCRAM_SHA_256
  • SASL_MECHANISM_SCRAM_SHA_512

saslUsername

string

saslPassword

string

enableSslCertificateVerification

boolean

maxPollIntervalMs

string (int64)

The minimum value is 0.

sessionTimeoutMs

string (int64)

The minimum value is 0.

debug

enum (Debug)

  • DEBUG_GENERIC
  • DEBUG_BROKER
  • DEBUG_TOPIC
  • DEBUG_METADATA
  • DEBUG_FEATURE
  • DEBUG_QUEUE
  • DEBUG_MSG
  • DEBUG_PROTOCOL
  • DEBUG_CGRP
  • DEBUG_SECURITY
  • DEBUG_FETCH
  • DEBUG_INTERCEPTOR
  • DEBUG_PLUGIN
  • DEBUG_CONSUMER
  • DEBUG_ADMIN
  • DEBUG_EOS
  • DEBUG_MOCK
  • DEBUG_ASSIGNOR
  • DEBUG_CONF
  • DEBUG_TELEMETRY
  • DEBUG_ALL

autoOffsetReset

enum (AutoOffsetReset)

  • AUTO_OFFSET_RESET_SMALLEST
  • AUTO_OFFSET_RESET_EARLIEST
  • AUTO_OFFSET_RESET_BEGINNING
  • AUTO_OFFSET_RESET_LARGEST
  • AUTO_OFFSET_RESET_LATEST
  • AUTO_OFFSET_RESET_END
  • AUTO_OFFSET_RESET_ERROR

messageMaxBytes

string (int64)

Acceptable values are 1000 to 1000000000, inclusive.

batchSize

string (int64)

Acceptable values are 1 to 2147483647, inclusive.

KafkaTopicKafkaTopic

Field

Description

name

string

settings

Kafka

RabbitmqRabbitmq

Field

Description

username

string

password

string

vhost

string

QueryMaskingRuleQueryMaskingRule

Field

Description

name

string

regexp

string

replace

string

QueryCacheQueryCache

Field

Description

maxSizeInBytes

string (int64)

The minimum value is 0.

maxEntries

string (int64)

The minimum value is 0.

maxEntrySizeInBytes

string (int64)

The minimum value is 0.

maxEntrySizeInRows

string (int64)

The minimum value is 0.

JdbcBridgeJdbcBridge

Field

Description

host

string

port

string (int64)

Acceptable values are 0 to 65535, inclusive.

MacroMacro

Field

Description

name

string

The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_][a-zA-Z0-9_-]*.

value

string

The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_][a-zA-Z0-9_-]*.

ResourcesResources

Field

Description

resourcePresetId

string

diskSize

string (int64)

diskTypeId

string

DiskSizeAutoscalingDiskSizeAutoscaling

Field

Description

plannedUsageThreshold

string (int64)

Acceptable values are 0 to 100, inclusive.

emergencyUsageThreshold

string (int64)

Acceptable values are 0 to 100, inclusive.

diskSizeLimit

string (int64)

ZookeeperZookeeper

Field

Description

resources

Resources

diskSizeAutoscaling

DiskSizeAutoscaling

TimeOfDayTimeOfDay

Field

Description

hours

integer (int32)

minutes

integer (int32)

seconds

integer (int32)

nanos

integer (int32)

AccessAccess

Field

Description

dataLens

boolean

webSql

boolean

metrika

boolean

serverless

boolean

dataTransfer

boolean

yandexQuery

boolean

CloudStorageCloudStorage

Field

Description

enabled

boolean

moveFactor

number (double)

Acceptable values are 0 to 1, inclusive.

dataCacheEnabled

boolean

dataCacheMaxSize

string (int64)

preferNotToMerge

boolean

PerformanceDiagnosticsPerformanceDiagnostics

Field

Description

enabled

boolean

processesRefreshInterval

string (duration)

MaintenanceWindowMaintenanceWindow

Field

Description

anytime

object

Includes only one of the fields anytime, weeklyMaintenanceWindow.

weeklyMaintenanceWindow

WeeklyMaintenanceWindow

Includes only one of the fields anytime, weeklyMaintenanceWindow.

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

Field

Description

day

enum (WeekDay)

  • MON
  • TUE
  • WED
  • THU
  • FRI
  • SAT
  • SUN

hour

string (int64)

Acceptable values are 1 to 24, inclusive.

MaintenanceOperationMaintenanceOperation

Field

Description

info

string

The maximum string length in characters is 256.

delayedUntil

string (date-time)

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

HostDetailsHostDetails

Field

Description

name

string

clusterId

string

zoneId

string

type

enum (Type)

  • CLICKHOUSE
  • ZOOKEEPER

resources

Resources

services[]

Service

subnetId

string

assignPublicIp

boolean

shardName

string

internalIpv4[]

string

ServiceService

Field

Description

type

enum (Type)

  • CLICKHOUSE
  • ZOOKEEPER
  • KEEPER

health

enum (Health)

  • UNKNOWN
  • ALIVE
  • DEAD
  • READONLY
  • RESTORING

DatabaseDatabase

Field

Description

name

string

clusterId

string

engine

enum (DatabaseEngine)

  • DATABASE_ENGINE_ATOMIC
  • DATABASE_ENGINE_REPLICATED

UserUser

Field

Description

name

string

clusterId

string

permissions[]

Permission

settings

UserSettings

quotas[]

UserQuota

connectionManager

ConnectionManager

PermissionPermission

Field

Description

databaseName

string

UserSettingsUserSettings

Field

Description

readonly

string (int64)

Acceptable values are 0 to 2, inclusive.

allowDdl

boolean

allowIntrospectionFunctions

boolean

connectTimeout

string (int64)

connectTimeoutWithFailover

string (int64)

receiveTimeout

string (int64)

sendTimeout

string (int64)

idleConnectionTimeout

string (int64)

timeoutBeforeCheckingExecutionSpeed

string (int64)

insertQuorum

string (int64)

The minimum value is 0.

insertQuorumTimeout

string (int64)

insertQuorumParallel

boolean

selectSequentialConsistency

boolean

replicationAlterPartitionsSync

string (int64)

Acceptable values are 0 to 2, inclusive.

maxReplicaDelayForDistributedQueries

string (int64)

fallbackToStaleReplicasForDistributedQueries

boolean

distributedProductMode

enum (DistributedProductMode)

  • DISTRIBUTED_PRODUCT_MODE_DENY
  • DISTRIBUTED_PRODUCT_MODE_LOCAL
  • DISTRIBUTED_PRODUCT_MODE_GLOBAL
  • DISTRIBUTED_PRODUCT_MODE_ALLOW

distributedAggregationMemoryEfficient

boolean

distributedDdlTaskTimeout

string (int64)

distributedDdlOutputMode

enum (DistributedDdlOutputMode)

  • DISTRIBUTED_DDL_OUTPUT_MODE_THROW
  • DISTRIBUTED_DDL_OUTPUT_MODE_NONE
  • DISTRIBUTED_DDL_OUTPUT_MODE_NULL_STATUS_ON_TIMEOUT
  • DISTRIBUTED_DDL_OUTPUT_MODE_NEVER_THROW
  • DISTRIBUTED_DDL_OUTPUT_MODE_NONE_ONLY_ACTIVE
  • DISTRIBUTED_DDL_OUTPUT_MODE_NULL_STATUS_ON_TIMEOUT_ONLY_ACTIVE
  • DISTRIBUTED_DDL_OUTPUT_MODE_THROW_ONLY_ACTIVE

skipUnavailableShards

boolean

useHedgedRequests

boolean

hedgedConnectionTimeoutMs

string (int64)

loadBalancing

enum (LoadBalancing)

  • LOAD_BALANCING_RANDOM
  • LOAD_BALANCING_NEAREST_HOSTNAME
  • LOAD_BALANCING_IN_ORDER
  • LOAD_BALANCING_FIRST_OR_RANDOM
  • LOAD_BALANCING_ROUND_ROBIN

preferLocalhostReplica

boolean

compileExpressions

boolean

minCountToCompileExpression

string (int64)

The minimum value is 0.

maxBlockSize

string (int64)

The minimum value is 1.

minInsertBlockSizeRows

string (int64)

The minimum value is 0.

minInsertBlockSizeBytes

string (int64)

The minimum value is 0.

maxInsertBlockSize

string (int64)

The minimum value is 1.

maxPartitionsPerInsertBlock

string (int64)

The minimum value is 0.

minBytesToUseDirectIo

string (int64)

The minimum value is 0.

useUncompressedCache

boolean

mergeTreeMaxRowsToUseCache

string (int64)

The minimum value is 1.

mergeTreeMaxBytesToUseCache

string (int64)

The minimum value is 1.

mergeTreeMinRowsForConcurrentRead

string (int64)

The minimum value is 1.

mergeTreeMinBytesForConcurrentRead

string (int64)

The minimum value is 1.

maxBytesBeforeExternalGroupBy

string (int64)

The minimum value is 0.

maxBytesBeforeExternalSort

string (int64)

The minimum value is 0.

groupByTwoLevelThreshold

string (int64)

The minimum value is 0.

groupByTwoLevelThresholdBytes

string (int64)

The minimum value is 0.

deduplicateBlocksInDependentMaterializedViews

boolean

localFilesystemReadMethod

enum (LocalFilesystemReadMethod)

  • LOCAL_FILESYSTEM_READ_METHOD_READ
  • LOCAL_FILESYSTEM_READ_METHOD_PREAD_THREADPOOL
  • LOCAL_FILESYSTEM_READ_METHOD_PREAD
  • LOCAL_FILESYSTEM_READ_METHOD_NMAP
  • LOCAL_FILESYSTEM_READ_METHOD_IO_URING

remoteFilesystemReadMethod

enum (RemoteFilesystemReadMethod)

  • REMOTE_FILESYSTEM_READ_METHOD_READ
  • REMOTE_FILESYSTEM_READ_METHOD_THREADPOOL

priority

string (int64)

The minimum value is 0.

maxThreads

string (int64)

The minimum value is 0.

maxInsertThreads

string (int64)

The minimum value is 0.

maxMemoryUsage

string (int64)

The minimum value is 0.

maxMemoryUsageForUser

string (int64)

The minimum value is 0.

memoryOvercommitRatioDenominator

string (int64)

The minimum value is 0.

memoryOvercommitRatioDenominatorForUser

string (int64)

The minimum value is 0.

memoryUsageOvercommitMaxWaitMicroseconds

string (int64)

The minimum value is 0.

maxNetworkBandwidth

string (int64)

The minimum value is 0.

maxNetworkBandwidthForUser

string (int64)

The minimum value is 0.

maxTemporaryDataOnDiskSizeForQuery

string (int64)

The minimum value is 0.

maxTemporaryDataOnDiskSizeForUser

string (int64)

The minimum value is 0.

maxConcurrentQueriesForUser

string (int64)

forceIndexByDate

boolean

forcePrimaryKey

boolean

maxRowsToRead

string (int64)

The minimum value is 0.

maxBytesToRead

string (int64)

The minimum value is 0.

readOverflowMode

enum (OverflowMode)

  • OVERFLOW_MODE_THROW
  • OVERFLOW_MODE_BREAK

maxRowsToGroupBy

string (int64)

The minimum value is 0.

groupByOverflowMode

enum (GroupByOverflowMode)

  • GROUP_BY_OVERFLOW_MODE_THROW
  • GROUP_BY_OVERFLOW_MODE_BREAK
  • GROUP_BY_OVERFLOW_MODE_ANY

maxRowsToSort

string (int64)

The minimum value is 0.

maxBytesToSort

string (int64)

The minimum value is 0.

sortOverflowMode

enum (OverflowMode)

  • OVERFLOW_MODE_THROW
  • OVERFLOW_MODE_BREAK

maxResultRows

string (int64)

The minimum value is 0.

maxResultBytes

string (int64)

The minimum value is 0.

resultOverflowMode

enum (OverflowMode)

  • OVERFLOW_MODE_THROW
  • OVERFLOW_MODE_BREAK

maxRowsInDistinct

string (int64)

The minimum value is 0.

maxBytesInDistinct

string (int64)

The minimum value is 0.

distinctOverflowMode

enum (OverflowMode)

  • OVERFLOW_MODE_THROW
  • OVERFLOW_MODE_BREAK

maxRowsToTransfer

string (int64)

The minimum value is 0.

maxBytesToTransfer

string (int64)

The minimum value is 0.

transferOverflowMode

enum (OverflowMode)

  • OVERFLOW_MODE_THROW
  • OVERFLOW_MODE_BREAK

maxExecutionTime

string (int64)

The minimum value is 0.

timeoutOverflowMode

enum (OverflowMode)

  • OVERFLOW_MODE_THROW
  • OVERFLOW_MODE_BREAK

maxRowsInSet

string (int64)

The minimum value is 0.

maxBytesInSet

string (int64)

The minimum value is 0.

setOverflowMode

enum (OverflowMode)

  • OVERFLOW_MODE_THROW
  • OVERFLOW_MODE_BREAK

maxRowsInJoin

string (int64)

The minimum value is 0.

maxBytesInJoin

string (int64)

The minimum value is 0.

joinOverflowMode

enum (OverflowMode)

  • OVERFLOW_MODE_THROW
  • OVERFLOW_MODE_BREAK

maxColumnsToRead

string (int64)

The minimum value is 0.

maxTemporaryColumns

string (int64)

The minimum value is 0.

maxTemporaryNonConstColumns

string (int64)

The minimum value is 0.

maxQuerySize

string (int64)

The minimum value is 1.

maxAstDepth

string (int64)

The minimum value is 1.

maxAstElements

string (int64)

The minimum value is 1.

maxExpandedAstElements

string (int64)

The minimum value is 1.

maxParserDepth

string (int64)

The minimum value is 0.

minExecutionSpeed

string (int64)

The minimum value is 0.

minExecutionSpeedBytes

string (int64)

The minimum value is 0.

inputFormatValuesInterpretExpressions

boolean

inputFormatDefaultsForOmittedFields

boolean

inputFormatNullAsDefault

boolean

inputFormatWithNamesUseHeader

boolean

outputFormatJsonQuote_64bitIntegers

boolean

outputFormatJsonQuoteDenormals

boolean

dateTimeInputFormat

enum (DateTimeInputFormat)

  • DATE_TIME_INPUT_FORMAT_BEST_EFFORT
  • DATE_TIME_INPUT_FORMAT_BASIC
  • DATE_TIME_INPUT_FORMAT_BEST_EFFORT_US

dateTimeOutputFormat

enum (DateTimeOutputFormat)

  • DATE_TIME_OUTPUT_FORMAT_SIMPLE
  • DATE_TIME_OUTPUT_FORMAT_ISO
  • DATE_TIME_OUTPUT_FORMAT_UNIX_TIMESTAMP

lowCardinalityAllowInNativeFormat

boolean

emptyResultForAggregationByEmptySet

boolean

formatRegexp

string

formatRegexpEscapingRule

enum (FormatRegexpEscapingRule)

  • FORMAT_REGEXP_ESCAPING_RULE_ESCAPED
  • FORMAT_REGEXP_ESCAPING_RULE_QUOTED
  • FORMAT_REGEXP_ESCAPING_RULE_CSV
  • FORMAT_REGEXP_ESCAPING_RULE_JSON
  • FORMAT_REGEXP_ESCAPING_RULE_XML
  • FORMAT_REGEXP_ESCAPING_RULE_RAW

formatRegexpSkipUnmatched

boolean

inputFormatParallelParsing

boolean

inputFormatImportNestedJson

boolean

formatAvroSchemaRegistryUrl

string

dataTypeDefaultNullable

boolean

httpConnectionTimeout

string (int64)

httpReceiveTimeout

string (int64)

httpSendTimeout

string (int64)

enableHttpCompression

boolean

sendProgressInHttpHeaders

boolean

httpHeadersProgressInterval

string (int64)

addHttpCorsHeader

boolean

cancelHttpReadonlyQueriesOnClientClose

boolean

maxHttpGetRedirects

string (int64)

httpMaxFieldNameSize

string (int64)

httpMaxFieldValueSize

string (int64)

quotaMode

enum (QuotaMode)

  • QUOTA_MODE_DEFAULT
  • QUOTA_MODE_KEYED
  • QUOTA_MODE_KEYED_BY_IP

asyncInsert

boolean

waitForAsyncInsert

boolean

waitForAsyncInsertTimeout

string (int64)

asyncInsertMaxDataSize

string (int64)

asyncInsertBusyTimeout

string (int64)

asyncInsertUseAdaptiveBusyTimeout

boolean

logQueryThreads

boolean

logQueryViews

boolean

logQueriesProbability

number (double)

logProcessorsProfiles

boolean

useQueryCache

boolean

enableReadsFromQueryCache

boolean

enableWritesToQueryCache

boolean

queryCacheMinQueryRuns

string (int64)

The minimum value is 0.

queryCacheMinQueryDuration

string (int64)

queryCacheTtl

string (int64)

queryCacheMaxEntries

string (int64)

queryCacheMaxSizeInBytes

string (int64)

queryCacheTag

string

queryCacheShareBetweenUsers

boolean

queryCacheNondeterministicFunctionHandling

enum (QueryCacheNondeterministicFunctionHandling)

  • QUERY_CACHE_NONDETERMINISTIC_FUNCTION_HANDLING_THROW
  • QUERY_CACHE_NONDETERMINISTIC_FUNCTION_HANDLING_SAVE
  • QUERY_CACHE_NONDETERMINISTIC_FUNCTION_HANDLING_IGNORE

queryCacheSystemTableHandling

enum (QueryCacheSystemTableHandling)

  • QUERY_CACHE_SYSTEM_TABLE_HANDLING_THROW
  • QUERY_CACHE_SYSTEM_TABLE_HANDLING_SAVE
  • QUERY_CACHE_SYSTEM_TABLE_HANDLING_IGNORE

countDistinctImplementation

enum (CountDistinctImplementation)

  • COUNT_DISTINCT_IMPLEMENTATION_UNIQ
  • COUNT_DISTINCT_IMPLEMENTATION_UNIQ_COMBINED
  • COUNT_DISTINCT_IMPLEMENTATION_UNIQ_COMBINED_64
  • COUNT_DISTINCT_IMPLEMENTATION_UNIQ_HLL_12
  • COUNT_DISTINCT_IMPLEMENTATION_UNIQ_EXACT

joinedSubqueryRequiresAlias

boolean

joinUseNulls

boolean

transformNullIn

boolean

insertNullAsDefault

boolean

joinAlgorithm[]

enum (JoinAlgorithm)

  • JOIN_ALGORITHM_HASH
  • JOIN_ALGORITHM_PARALLEL_HASH
  • JOIN_ALGORITHM_PARTIAL_MERGE
  • JOIN_ALGORITHM_DIRECT
  • JOIN_ALGORITHM_AUTO
  • JOIN_ALGORITHM_FULL_SORTING_MERGE
  • JOIN_ALGORITHM_PREFER_PARTIAL_MERGE

anyJoinDistinctRightTableKeys

boolean

allowSuspiciousLowCardinalityTypes

boolean

flattenNested

boolean

memoryProfilerStep

string (int64)

The minimum value is 0.

memoryProfilerSampleProbability

number (double)

Acceptable values are 0 to 1, inclusive.

maxFinalThreads

string (int64)

The minimum value is 0.

maxReadBufferSize

string (int64)

The minimum value is 1.

insertKeeperMaxRetries

string (int64)

The minimum value is 0.

doNotMergeAcrossPartitionsSelectFinal

boolean

ignoreMaterializedViewsWithDroppedTargetTable

boolean

enableAnalyzer

boolean

s3UseAdaptiveTimeouts

boolean

final

boolean

useHivePartitioning

boolean

showDataLakeCatalogsInSystemTables

boolean

compile

boolean

minCountToCompile

string (int64)

asyncInsertThreads

string (int64)

asyncInsertStaleTimeout

string (int64)

UserQuotaUserQuota

Field

Description

intervalDuration

string (int64)

The minimum value is 1000.

queries

string (int64)

The minimum value is 0.

errors

string (int64)

The minimum value is 0.

resultRows

string (int64)

The minimum value is 0.

readRows

string (int64)

The minimum value is 0.

executionTime

string (int64)

The minimum value is 0.

ConnectionManagerConnectionManager

Field

Description

connectionId

string

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

Предыдущая
BackupCluster
Следующая
CreateClusterExtension
Создавайте контент и получайте гранты!Готовы написать своё руководство? Участвуйте в контент-программе и получайте гранты на работу с облачными сервисами!
Подробнее о программе
Проект Яндекса
© 2026 ТОО «Облачные Сервисы Казахстан»