Managed Service for ClickHouse Audit Trails Events: BackupCluster
- Event JSON schema
- Field description
- IamAuthentication
- IamTokenInfo
- Authorization
- ResourceMetadata
- Resource
- RequestMetadata
- Status
- ClusterBackupEventDetails
- 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
- Tls
- UserSettings
- Resources
- DiskSizeAutoscaling
- Zookeeper
- TimeOfDay
- Access
- CloudStorage
- PerformanceDiagnostics
- MaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
- Backup
Event 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",
"backupId": "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",
"replicatedDeduplicationWindowForAsyncInserts": "string",
"replicatedDeduplicationWindowSecondsForAsyncInserts": "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"
}
],
"tls": {
"trustedCertificates": [
"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",
"replicatedDeduplicationWindowForAsyncInserts": "string",
"replicatedDeduplicationWindowSecondsForAsyncInserts": "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"
}
],
"tls": {
"trustedCertificates": [
"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",
"replicatedDeduplicationWindowForAsyncInserts": "string",
"replicatedDeduplicationWindowSecondsForAsyncInserts": "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"
}
],
"tls": {
"trustedCertificates": [
"string"
]
},
"builtinDictionariesReloadInterval": "string"
}
},
"defaultUserSettings": {
"readonly": "string",
"allowDdl": "boolean",
"allowIntrospectionFunctions": "boolean",
"connectTimeout": "string",
"connectTimeoutWithFailover": "string",
"connectTimeoutWithFailoverSecure": "string",
"connectionsWithFailoverMaxTries": "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",
"maxBytesRatioBeforeExternalGroupBy": "number",
"maxBytesRatioBeforeExternalSort": "number",
"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",
"maxNetworkBytes": "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"
},
"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",
"performanceDiagnostics": {
"enabled": "boolean",
"processesRefreshInterval": "string"
},
"fullVersion": "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"
},
"backup": {
"id": "string",
"folderId": "string",
"createdAt": "string",
"sourceClusterId": "string",
"sourceShardNames": [
"string"
],
"startedAt": "string",
"size": "string",
"type": "string"
}
},
"requestParameters": "object",
"response": "object"
}
Field 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 To work with values in this field, use the APIs described in the |
|
authentication |
|
|
authorization |
|
|
resourceMetadata |
|
|
requestMetadata |
|
|
eventStatus |
enum (EventStatus)
|
|
error |
The error result of the operation in case of failure or cancellation. |
|
details |
|
|
requestParameters |
object |
|
response |
object |
IamAuthentication
|
Field |
Description |
|
authenticated |
boolean |
|
subjectType |
enum (IamSubjectType) Includes only one of the fields
|
|
subjectId |
string Includes only one of the fields |
|
subjectName |
string Includes only one of the fields |
|
federationId |
string Includes only one of the fields |
|
federationName |
string Includes only one of the fields |
|
federationType |
enum (FederationType) Includes only one of the fields
|
|
tokenInfo |
IamTokenInfo
|
Field |
Description |
|
maskedIamToken |
string |
|
iamTokenId |
string Includes only one of the fields |
|
impersonatorId |
string Includes only one of the fields |
|
impersonatorType |
enum (IamSubjectType) Includes only one of the fields
|
|
impersonatorName |
string Includes only one of the fields |
|
impersonatorFederationId |
string Includes only one of the fields |
|
impersonatorFederationName |
string Includes only one of the fields |
|
impersonatorFederationType |
enum (FederationType) Includes only one of the fields
|
Authorization
|
Field |
Description |
|
authorized |
boolean |
ResourceMetadata
|
Field |
Description |
|
path[] |
Resource
|
Field |
Description |
|
resourceType |
string |
|
resourceId |
string |
|
resourceName |
string Includes only one of the fields |
RequestMetadata
|
Field |
Description |
|
remoteAddress |
string |
|
userAgent |
string |
|
requestId |
string |
|
remotePort |
string (int64) Includes only one of the fields |
Status
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. |
ClusterBackupEventDetails
|
Field |
Description |
|
clusterId |
string |
|
backupId |
string |
|
clusterName |
string |
|
cluster |
|
|
backup |
Cluster
|
Field |
Description |
|
id |
string |
|
folderId |
string |
|
createdAt |
string (date-time) String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
name |
string |
|
description |
string |
|
labels |
object (map<string, string>) |
|
environment |
enum (Environment)
|
|
monitoring[] |
|
|
config |
|
|
networkId |
string |
|
health |
enum (Health)
|
|
status |
enum (Status)
|
|
serviceAccountId |
string |
|
maintenanceWindow |
|
|
plannedOperation |
|
|
securityGroupIds[] |
string |
|
deletionProtection |
boolean |
|
diskEncryptionKeyId |
string |
Monitoring
|
Field |
Description |
|
name |
string |
|
description |
string |
|
link |
string |
ClusterConfig
|
Field |
Description |
|
version |
string |
|
clickhouse |
|
|
zookeeper |
|
|
backupWindowStart |
|
|
access |
|
|
cloudStorage |
|
|
sqlDatabaseManagement |
boolean |
|
sqlUserManagement |
boolean |
|
embeddedKeeper |
boolean |
|
backupRetainPeriodDays |
string (int64) |
|
performanceDiagnostics |
|
|
fullVersion |
string |
Clickhouse
|
Field |
Description |
|
config |
|
|
defaultUserSettings |
|
|
resources |
|
|
diskSizeAutoscaling |
ClickhouseConfigSet
|
Field |
Description |
|
effectiveConfig |
|
|
userConfig |
|
|
defaultConfig |
ClickhouseConfig
|
Field |
Description |
|
backgroundPoolSize |
string (int64) |
|
backgroundMergesMutationsConcurrencyRatio |
string (int64) |
|
backgroundSchedulePoolSize |
string (int64) |
|
backgroundFetchesPoolSize |
string (int64) |
|
backgroundMovePoolSize |
string (int64) |
|
backgroundDistributedSchedulePoolSize |
string (int64) |
|
backgroundBufferFlushSchedulePoolSize |
string (int64) |
|
backgroundMessageBrokerSchedulePoolSize |
string (int64) |
|
backgroundCommonPoolSize |
string (int64) |
|
dictionariesLazyLoad |
boolean |
|
logLevel |
enum (LogLevel)
|
|
queryLogRetentionSize |
string (int64) |
|
queryLogRetentionTime |
string (int64) |
|
queryThreadLogEnabled |
boolean |
|
queryThreadLogRetentionSize |
string (int64) |
|
queryThreadLogRetentionTime |
string (int64) |
|
partLogRetentionSize |
string (int64) |
|
partLogRetentionTime |
string (int64) |
|
metricLogEnabled |
boolean |
|
metricLogRetentionSize |
string (int64) |
|
metricLogRetentionTime |
string (int64) |
|
traceLogEnabled |
boolean |
|
traceLogRetentionSize |
string (int64) |
|
traceLogRetentionTime |
string (int64) |
|
textLogEnabled |
boolean |
|
textLogRetentionSize |
string (int64) |
|
textLogRetentionTime |
string (int64) |
|
textLogLevel |
enum (LogLevel)
|
|
opentelemetrySpanLogEnabled |
boolean |
|
opentelemetrySpanLogRetentionSize |
string (int64) |
|
opentelemetrySpanLogRetentionTime |
string (int64) |
|
queryViewsLogEnabled |
boolean |
|
queryViewsLogRetentionSize |
string (int64) |
|
queryViewsLogRetentionTime |
string (int64) |
|
asynchronousMetricLogEnabled |
boolean |
|
asynchronousMetricLogRetentionSize |
string (int64) |
|
asynchronousMetricLogRetentionTime |
string (int64) |
|
sessionLogEnabled |
boolean |
|
sessionLogRetentionSize |
string (int64) |
|
sessionLogRetentionTime |
string (int64) |
|
zookeeperLogEnabled |
boolean |
|
zookeeperLogRetentionSize |
string (int64) |
|
zookeeperLogRetentionTime |
string (int64) |
|
asynchronousInsertLogEnabled |
boolean |
|
asynchronousInsertLogRetentionSize |
string (int64) |
|
asynchronousInsertLogRetentionTime |
string (int64) |
|
processorsProfileLogEnabled |
boolean |
|
processorsProfileLogRetentionSize |
string (int64) |
|
processorsProfileLogRetentionTime |
string (int64) |
|
errorLogEnabled |
boolean |
|
errorLogRetentionSize |
string (int64) |
|
errorLogRetentionTime |
string (int64) |
|
queryMetricLogEnabled |
boolean |
|
queryMetricLogRetentionSize |
string (int64) |
|
queryMetricLogRetentionTime |
string (int64) |
|
accessControlImprovements |
|
|
maxConnections |
string (int64) |
|
maxConcurrentQueries |
string (int64) |
|
maxTableSizeToDrop |
string (int64) |
|
maxPartitionSizeToDrop |
string (int64) |
|
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) |
|
backupThreads |
string (int64) |
|
restoreThreads |
string (int64) |
|
vectorSimilarityIndexCacheSize |
string (int64) |
|
vectorSimilarityIndexCacheMaxEntries |
string (int64) |
|
maxBuildVectorSimilarityIndexThreadPoolSize |
string (int64) |
|
mergeTree |
|
|
compression[] |
|
|
dictionaries[] |
|
|
graphiteRollup[] |
|
|
kafka |
|
|
kafkaTopics[] |
|
|
rabbitmq |
|
|
queryMaskingRules[] |
|
|
queryCache |
|
|
jdbcBridge |
|
|
mysqlProtocol |
boolean |
|
customMacros[] |
|
|
tls |
|
|
builtinDictionariesReloadInterval |
string (int64) |
AccessControlImprovements
|
Field |
Description |
|
selectFromSystemDbRequiresGrant |
boolean |
|
selectFromInformationSchemaRequiresGrant |
boolean |
MergeTree
|
Field |
Description |
|
partsToDelayInsert |
string (int64) |
|
partsToThrowInsert |
string (int64) |
|
inactivePartsToDelayInsert |
string (int64) |
|
inactivePartsToThrowInsert |
string (int64) |
|
maxAvgPartSizeForTooManyParts |
string (int64) |
|
maxPartsInTotal |
string (int64) |
|
maxReplicatedMergesInQueue |
string (int64) |
|
numberOfFreeEntriesInPoolToLowerMaxSizeOfMerge |
string (int64) |
|
numberOfFreeEntriesInPoolToExecuteMutation |
string (int64) |
|
numberOfFreeEntriesInPoolToExecuteOptimizeEntirePartition |
string (int64) |
|
maxBytesToMergeAtMinSpaceInPool |
string (int64) |
|
maxBytesToMergeAtMaxSpaceInPool |
string (int64) |
|
minBytesForWidePart |
string (int64) |
|
minRowsForWidePart |
string (int64) |
|
cleanupDelayPeriod |
string (int64) |
|
maxCleanupDelayPeriod |
string (int64) |
|
mergeSelectingSleepMs |
string (int64) |
|
maxMergeSelectingSleepMs |
string (int64) |
|
minAgeToForceMergeSeconds |
string (int64) |
|
minAgeToForceMergeOnPartitionOnly |
boolean |
|
mergeMaxBlockSize |
string (int64) |
|
deduplicateMergeProjectionMode |
enum (DeduplicateMergeProjectionMode)
|
|
lightweightMutationProjectionMode |
enum (LightweightMutationProjectionMode)
|
|
replicatedDeduplicationWindow |
string (int64) |
|
replicatedDeduplicationWindowSeconds |
string (int64) |
|
replicatedDeduplicationWindowForAsyncInserts |
string (int64) |
|
replicatedDeduplicationWindowSecondsForAsyncInserts |
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 |
Compression
|
Field |
Description |
|
method |
enum (Method)
|
|
minPartSize |
string (int64) |
|
minPartSizeRatio |
string |
|
level |
string (int64) |
ExternalDictionary
|
Field |
Description |
|
name |
string |
|
structure |
|
|
layout |
|
|
fixedLifetime |
string (int64) Includes only one of the fields |
|
lifetimeRange |
Includes only one of the fields |
|
httpSource |
Includes only one of the fields |
|
mysqlSource |
Includes only one of the fields |
|
clickhouseSource |
Includes only one of the fields |
|
mongodbSource |
Includes only one of the fields |
|
postgresqlSource |
Includes only one of the fields |
Structure
|
Field |
Description |
|
id |
|
|
key |
|
|
rangeMin |
|
|
rangeMax |
|
|
attributes[] |
The number of elements must be greater than 0. |
Id
|
Field |
Description |
|
name |
string |
Key
|
Field |
Description |
|
attributes[] |
The number of elements must be greater than 0. |
Attribute
|
Field |
Description |
|
name |
string |
|
type |
string |
|
nullValue |
string |
|
expression |
string |
|
hierarchical |
boolean |
|
injective |
boolean |
Layout
|
Field |
Description |
|
type |
enum (Type)
|
|
sizeInCells |
string (int64) |
|
allowReadExpiredKeys |
boolean |
|
maxUpdateQueueSize |
string (int64) |
|
updateQueuePushTimeoutMilliseconds |
string (int64) |
|
queryWaitTimeoutMilliseconds |
string (int64) |
|
maxThreadsForUpdates |
string (int64) |
|
initialArraySize |
string (int64) |
|
maxArraySize |
string (int64) |
|
accessToKeyFromAttributes |
boolean |
Range
|
Field |
Description |
|
min |
string (int64) |
|
max |
string (int64) |
HttpSource
|
Field |
Description |
|
url |
string |
|
format |
string |
|
headers[] |
Header
|
Field |
Description |
|
name |
string |
|
value |
string |
MysqlSource
|
Field |
Description |
|
db |
string |
|
table |
string |
|
port |
string (int64) |
|
user |
string |
|
password |
string |
|
replicas[] |
|
|
where |
string |
|
invalidateQuery |
string |
|
closeConnection |
boolean |
|
shareConnection |
boolean |
Replica
|
Field |
Description |
|
host |
string The maximum string length in characters is 253. |
|
priority |
string (int64) |
|
port |
string (int64) |
|
user |
string |
|
password |
string |
ClickhouseSource
|
Field |
Description |
|
db |
string |
|
table |
string |
|
host |
string The maximum string length in characters is 253. |
|
port |
string (int64) |
|
user |
string |
|
password |
string |
|
where |
string |
|
secure |
boolean |
MongodbSource
|
Field |
Description |
|
db |
string |
|
collection |
string |
|
host |
string The maximum string length in characters is 253. |
|
port |
string (int64) |
|
user |
string |
|
password |
string |
|
options |
string |
PostgresqlSource
|
Field |
Description |
|
db |
string |
|
table |
string |
|
hosts[] |
string |
|
port |
string (int64) |
|
user |
string |
|
password |
string |
|
invalidateQuery |
string |
|
sslMode |
enum (SslMode)
|
GraphiteRollup
|
Field |
Description |
|
name |
string |
|
patterns[] |
The number of elements must be greater than 0. |
|
pathColumnName |
string |
|
timeColumnName |
string |
|
valueColumnName |
string |
|
versionColumnName |
string |
Pattern
|
Field |
Description |
|
regexp |
string |
|
function |
string |
|
retention[] |
Retention
|
Field |
Description |
|
age |
string (int64) |
|
precision |
string (int64) |
Kafka
|
Field |
Description |
|
securityProtocol |
enum (SecurityProtocol)
|
|
saslMechanism |
enum (SaslMechanism)
|
|
saslUsername |
string |
|
saslPassword |
string |
|
enableSslCertificateVerification |
boolean |
|
maxPollIntervalMs |
string (int64) |
|
sessionTimeoutMs |
string (int64) |
|
debug |
enum (Debug)
|
|
autoOffsetReset |
enum (AutoOffsetReset)
|
|
messageMaxBytes |
string (int64) |
|
batchSize |
string (int64) |
KafkaTopic
|
Field |
Description |
|
name |
string |
|
settings |
Rabbitmq
|
Field |
Description |
|
username |
string |
|
password |
string |
|
vhost |
string |
QueryMaskingRule
|
Field |
Description |
|
name |
string |
|
regexp |
string |
|
replace |
string |
QueryCache
|
Field |
Description |
|
maxSizeInBytes |
string (int64) |
|
maxEntries |
string (int64) |
|
maxEntrySizeInBytes |
string (int64) |
|
maxEntrySizeInRows |
string (int64) |
JdbcBridge
|
Field |
Description |
|
host |
string |
|
port |
string (int64) |
Macro
|
Field |
Description |
|
name |
string The maximum string length in characters is 63. |
|
value |
string The maximum string length in characters is 63. |
Tls
|
Field |
Description |
|
trustedCertificates[] |
string |
UserSettings
|
Field |
Description |
|
readonly |
string (int64) |
|
allowDdl |
boolean |
|
allowIntrospectionFunctions |
boolean |
|
connectTimeout |
string (int64) |
|
connectTimeoutWithFailover |
string (int64) |
|
connectTimeoutWithFailoverSecure |
string (int64) |
|
connectionsWithFailoverMaxTries |
string (int64) |
|
receiveTimeout |
string (int64) |
|
sendTimeout |
string (int64) |
|
idleConnectionTimeout |
string (int64) |
|
timeoutBeforeCheckingExecutionSpeed |
string (int64) |
|
insertQuorum |
string (int64) |
|
insertQuorumTimeout |
string (int64) |
|
insertQuorumParallel |
boolean |
|
selectSequentialConsistency |
boolean |
|
replicationAlterPartitionsSync |
string (int64) |
|
maxReplicaDelayForDistributedQueries |
string (int64) |
|
fallbackToStaleReplicasForDistributedQueries |
boolean |
|
distributedProductMode |
enum (DistributedProductMode)
|
|
distributedAggregationMemoryEfficient |
boolean |
|
distributedDdlTaskTimeout |
string (int64) |
|
distributedDdlOutputMode |
enum (DistributedDdlOutputMode)
|
|
skipUnavailableShards |
boolean |
|
useHedgedRequests |
boolean |
|
hedgedConnectionTimeoutMs |
string (int64) |
|
loadBalancing |
enum (LoadBalancing)
|
|
preferLocalhostReplica |
boolean |
|
compileExpressions |
boolean |
|
minCountToCompileExpression |
string (int64) |
|
maxBlockSize |
string (int64) |
|
minInsertBlockSizeRows |
string (int64) |
|
minInsertBlockSizeBytes |
string (int64) |
|
maxInsertBlockSize |
string (int64) |
|
maxPartitionsPerInsertBlock |
string (int64) |
|
minBytesToUseDirectIo |
string (int64) |
|
useUncompressedCache |
boolean |
|
mergeTreeMaxRowsToUseCache |
string (int64) |
|
mergeTreeMaxBytesToUseCache |
string (int64) |
|
mergeTreeMinRowsForConcurrentRead |
string (int64) |
|
mergeTreeMinBytesForConcurrentRead |
string (int64) |
|
maxBytesBeforeExternalGroupBy |
string (int64) |
|
maxBytesRatioBeforeExternalGroupBy |
number (double) |
|
maxBytesRatioBeforeExternalSort |
number (double) |
|
maxBytesBeforeExternalSort |
string (int64) |
|
groupByTwoLevelThreshold |
string (int64) |
|
groupByTwoLevelThresholdBytes |
string (int64) |
|
deduplicateBlocksInDependentMaterializedViews |
boolean |
|
localFilesystemReadMethod |
enum (LocalFilesystemReadMethod)
|
|
remoteFilesystemReadMethod |
enum (RemoteFilesystemReadMethod)
|
|
priority |
string (int64) |
|
maxThreads |
string (int64) |
|
maxInsertThreads |
string (int64) |
|
maxMemoryUsage |
string (int64) |
|
maxMemoryUsageForUser |
string (int64) |
|
memoryOvercommitRatioDenominator |
string (int64) |
|
memoryOvercommitRatioDenominatorForUser |
string (int64) |
|
memoryUsageOvercommitMaxWaitMicroseconds |
string (int64) |
|
maxNetworkBandwidth |
string (int64) |
|
maxNetworkBandwidthForUser |
string (int64) |
|
maxNetworkBytes |
string (int64) |
|
maxTemporaryDataOnDiskSizeForQuery |
string (int64) |
|
maxTemporaryDataOnDiskSizeForUser |
string (int64) |
|
maxConcurrentQueriesForUser |
string (int64) |
|
forceIndexByDate |
boolean |
|
forcePrimaryKey |
boolean |
|
maxRowsToRead |
string (int64) |
|
maxBytesToRead |
string (int64) |
|
readOverflowMode |
enum (OverflowMode)
|
|
maxRowsToGroupBy |
string (int64) |
|
groupByOverflowMode |
enum (GroupByOverflowMode)
|
|
maxRowsToSort |
string (int64) |
|
maxBytesToSort |
string (int64) |
|
sortOverflowMode |
enum (OverflowMode)
|
|
maxResultRows |
string (int64) |
|
maxResultBytes |
string (int64) |
|
resultOverflowMode |
enum (OverflowMode)
|
|
maxRowsInDistinct |
string (int64) |
|
maxBytesInDistinct |
string (int64) |
|
distinctOverflowMode |
enum (OverflowMode)
|
|
maxRowsToTransfer |
string (int64) |
|
maxBytesToTransfer |
string (int64) |
|
transferOverflowMode |
enum (OverflowMode)
|
|
maxExecutionTime |
string (int64) |
|
timeoutOverflowMode |
enum (OverflowMode)
|
|
maxRowsInSet |
string (int64) |
|
maxBytesInSet |
string (int64) |
|
setOverflowMode |
enum (OverflowMode)
|
|
maxRowsInJoin |
string (int64) |
|
maxBytesInJoin |
string (int64) |
|
joinOverflowMode |
enum (OverflowMode)
|
|
maxColumnsToRead |
string (int64) |
|
maxTemporaryColumns |
string (int64) |
|
maxTemporaryNonConstColumns |
string (int64) |
|
maxQuerySize |
string (int64) |
|
maxAstDepth |
string (int64) |
|
maxAstElements |
string (int64) |
|
maxExpandedAstElements |
string (int64) |
|
maxParserDepth |
string (int64) |
|
minExecutionSpeed |
string (int64) |
|
minExecutionSpeedBytes |
string (int64) |
|
inputFormatValuesInterpretExpressions |
boolean |
|
inputFormatDefaultsForOmittedFields |
boolean |
|
inputFormatNullAsDefault |
boolean |
|
inputFormatWithNamesUseHeader |
boolean |
|
outputFormatJsonQuote_64bitIntegers |
boolean |
|
outputFormatJsonQuoteDenormals |
boolean |
|
dateTimeInputFormat |
enum (DateTimeInputFormat)
|
|
dateTimeOutputFormat |
enum (DateTimeOutputFormat)
|
|
lowCardinalityAllowInNativeFormat |
boolean |
|
emptyResultForAggregationByEmptySet |
boolean |
|
formatRegexp |
string |
|
formatRegexpEscapingRule |
enum (FormatRegexpEscapingRule)
|
|
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)
|
|
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) |
|
queryCacheMinQueryDuration |
string (int64) |
|
queryCacheTtl |
string (int64) |
|
queryCacheMaxEntries |
string (int64) |
|
queryCacheMaxSizeInBytes |
string (int64) |
|
queryCacheTag |
string |
|
queryCacheShareBetweenUsers |
boolean |
|
queryCacheNondeterministicFunctionHandling |
enum (QueryCacheNondeterministicFunctionHandling)
|
|
queryCacheSystemTableHandling |
enum (QueryCacheSystemTableHandling)
|
|
countDistinctImplementation |
enum (CountDistinctImplementation)
|
|
joinedSubqueryRequiresAlias |
boolean |
|
joinUseNulls |
boolean |
|
transformNullIn |
boolean |
|
insertNullAsDefault |
boolean |
|
joinAlgorithm[] |
enum (JoinAlgorithm)
|
|
anyJoinDistinctRightTableKeys |
boolean |
|
allowSuspiciousLowCardinalityTypes |
boolean |
|
flattenNested |
boolean |
|
memoryProfilerStep |
string (int64) |
|
memoryProfilerSampleProbability |
number (double) |
|
maxFinalThreads |
string (int64) |
|
maxReadBufferSize |
string (int64) |
|
insertKeeperMaxRetries |
string (int64) |
|
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) |
Resources
|
Field |
Description |
|
resourcePresetId |
string |
|
diskSize |
string (int64) |
|
diskTypeId |
string |
DiskSizeAutoscaling
|
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) |
Zookeeper
|
Field |
Description |
|
resources |
|
|
diskSizeAutoscaling |
TimeOfDay
|
Field |
Description |
|
hours |
integer (int32) |
|
minutes |
integer (int32) |
|
seconds |
integer (int32) |
|
nanos |
integer (int32) |
Access
|
Field |
Description |
|
dataLens |
boolean |
|
webSql |
boolean |
|
metrika |
boolean |
|
serverless |
boolean |
|
dataTransfer |
boolean |
|
yandexQuery |
boolean |
CloudStorage
|
Field |
Description |
|
enabled |
boolean |
|
moveFactor |
number (double) Acceptable values are 0 to 1, inclusive. |
|
dataCacheEnabled |
boolean |
|
dataCacheMaxSize |
string (int64) |
|
preferNotToMerge |
boolean |
PerformanceDiagnostics
|
Field |
Description |
|
enabled |
boolean |
|
processesRefreshInterval |
string (duration) |
MaintenanceWindow
|
Field |
Description |
|
anytime |
object Includes only one of the fields |
|
weeklyMaintenanceWindow |
Includes only one of the fields |
WeeklyMaintenanceWindow
|
Field |
Description |
|
day |
enum (WeekDay)
|
|
hour |
string (int64) Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
|
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 To work with values in this field, use the APIs described in the |
Backup
|
Field |
Description |
|
id |
string |
|
folderId |
string |
|
createdAt |
string (date-time) String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
sourceClusterId |
string |
|
sourceShardNames[] |
string |
|
startedAt |
string (date-time) String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
size |
string (int64) |
|
type |
enum (BackupType)
|