ClickHouse API models

Option

Description

TYPE_INVALID

TYPE_AUTOMATED

Backup created by automated daily schedule

TYPE_MANUAL

Backup created by user request

Option

Description

CLUSTER_VIEW_INVALID

Invalid cluster view value.

CLUSTER_VIEW_BASIC

Output basic information about the cluster.

CLUSTER_VIEW_FULL

Output full information about the cluster including allocated resources and ClickHouse settings.

Option

Description

METHOD_INVALID

METHOD_LZ4

METHOD_ZSTD

METHOD_LZ4HC

Option

Description

SASL_MECHANISM_INVALID

SASL_MECHANISM_GSSAPI

SASL_MECHANISM_PLAIN

SASL_MECHANISM_SCRAM_SHA_256

SASL_MECHANISM_SCRAM_SHA_512

Option

Description

SECURITY_PROTOCOL_INVALID

SECURITY_PROTOCOL_PLAINTEXT

SECURITY_PROTOCOL_SSL

SECURITY_PROTOCOL_SASL_PLAINTEXT

SECURITY_PROTOCOL_SASL_SSL

Option

Description

LOG_LEVEL_INVALID

LOG_LEVEL_TRACE

LOG_LEVEL_DEBUG

LOG_LEVEL_INFORMATION

LOG_LEVEL_WARNING

LOG_LEVEL_ERROR

Field

Description

id

string Required. ID of the backup.

project_id

string ID of the project that the backup belongs to.

name

string User defined or autogenerated backup name. Contains shard name until we implement consistent multishard backups.

create_time

google.protobuf.Timestamp The time when the backup was created (i.e. when the backup operation completed).

start_time

google.protobuf.Timestamp The time when the backup operation was started.

source_cluster_id

string ID of the associated ClickHouse cluster.

size

int64 Size of backup in bytes

type

doublecloud.clickhouse.v1.Backup.Type How this backup was created (manual/automatic/etc...)

Field

Description

cluster_id

string Required. ID of the ClickHouse cluster to back up.

name

string Optional. Name of the ClickHouse cluster backup.

Field

Description

backup_id

string Required. ID of the backup to delete.

Field

Description

backup_id

string Required. ID of the backup to return.

Field

Description

project_id

string Required. ID of the project to list backups in.

paging

doublecloud.v1.Paging Paging information of the request

Field

Description

backups

list Requested list of backups.

backups[]

doublecloud.clickhouse.v1.Backup

next_page

doublecloud.v1.NextPage Pagination information of the response

Field

Description

id

string ID of the ClickHouse cluster.

project_id

string ID of the project that the ClickHouse cluster belongs to.

cloud_type

string Type of the cloud where instances should be hosted.

region_id

string ID of the region to place instances.

create_time

google.protobuf.Timestamp Creation timestamp.

name

string Name of the ClickHouse cluster. The name is unique within the project.

description

string Description of the ClickHouse cluster.

status

doublecloud.v1.ClusterStatus Current state of the cluster.

version

string Version of ClickHouse DBMS.

resources

doublecloud.clickhouse.v1.ClusterResources Resources allocated to the ClickHouse cluster.

connection_info

doublecloud.clickhouse.v1.ConnectionInfo Connection information.

access

doublecloud.v1.Access Access settings

private_connection_info

doublecloud.clickhouse.v1.PrivateConnectionInfo Private connection information.

encryption

doublecloud.v1.DataEncryption DataEncryption settings

network_id

string ID of the network that the ClickHouse cluster belongs to.

clickhouse_config

doublecloud.clickhouse.v1.ClickhouseConfig ClickHouse server configuration.

maintenance_window

doublecloud.v1.MaintenanceWindow Window of maintenance operations.

maintenance_operation

doublecloud.v1.MaintenanceOperation Maintenance operation planned at nearest maintenance_window.

metrics_exporter_connection_info

doublecloud.clickhouse.v1.MetricsExporterConnectionInfo Prometheus JMX exporter endpoint HTTP basic auth information.

Field

Description

clickhouse

doublecloud.clickhouse.v1.ClusterResources.Clickhouse Resources allocated to ClickHouse hosts.

Field

Description

resource_preset_id

string ID of the preset for computational resources available to a host (CPU, memory etc.).

disk_size

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

max_disk_size

google.protobuf.Int64Value Maximum storage volume the cluster can automatically scale up to in bytes. If not set, autoscaling is disabled

replica_count

google.protobuf.Int64Value Number of hosts per shard.

shard_count

google.protobuf.Int64Value Number of shards in the cluster.

Field

Description

host

string Host to connect.

user

string ClickHouse user.

password

string Password for ClickHouse user.

https_port

google.protobuf.Int64Value Port to connect using HTTPS protocol.

tcp_port_secure

google.protobuf.Int64Value Port to connect using TCP/native protocol.

native_protocol

string Connection string for ClickHouse native protocol.

https_uri

string URI to connect using HTTPS protocol.

jdbc_uri

string URI to connect using JDBC protocol.

odbc_uri

string URI to connect using ODBC protocol.

Field

Description

name

string Name of the host.

cluster_id

string ID of the ClickHouse cluster.

shard_name

string Name of the shard that the host belongs to.

private_name

string Private dns name.

status

doublecloud.v1.HostStatus Aggregated host status.

Field

Description

user

string User for HTTP basic auth.

password

string Password for HTTP basic auth.

Field

Description

host

string Host to connect.

user

string ClickHouse user.

password

string Password for ClickHouse user.

https_port

google.protobuf.Int64Value Port to connect using HTTPS protocol.

tcp_port_secure

google.protobuf.Int64Value Port to connect using TCP/native protocol.

native_protocol

string Connection string for ClickHouse native protocol.

https_uri

string URI to connect using HTTPS protocol.

jdbc_uri

string URI to connect using JDBC protocol.

odbc_uri

string URI to connect using ODBC protocol.

Field

Description

project_id

string ID of the project to create the ClickHouse cluster in.

cloud_type

string Type of the cloud where instances should be hosted.

region_id

string ID of the region to place instances.

name

string Name of the ClickHouse cluster. The name must be unique within the project.

description

string Description of the ClickHouse cluster.

version

string Version of ClickHouse DBMS.

resources

doublecloud.clickhouse.v1.ClusterResources Resources allocated to the ClickHouse cluster.

access

doublecloud.v1.Access Access settings

encryption

doublecloud.v1.DataEncryption DataEncryption settings

network_id

string ID of the network to create ClickHouse cluster in.

clickhouse_config

doublecloud.clickhouse.v1.ClickhouseConfig ClickHouse server configuration.

maintenance_window

doublecloud.v1.MaintenanceWindow Window of maintenance operations.

Field

Description

cluster_id

string ID of the ClickHouse cluster to delete. To get the ClickHouse cluster ID, use a [ClusterService.List] request.

Field

Description

cluster_id

string ID of the ClickHouse cluster resource to return.

sensitive

bool Whether to include sensitive data in the response. If unspecified, defaults to false.

Field

Description

cluster_id

string Required. ID of the ClickHouse cluster.

paging

doublecloud.v1.Paging Paging information of the request

Field

Description

backups

list Requested list of backups.

backups[]

doublecloud.clickhouse.v1.Backup

next_page

doublecloud.v1.NextPage Pagination information of the response

Field

Description

cluster_id

string ID of the ClickHouse cluster to list hosts in.

paging

doublecloud.v1.Paging Paging information of the request

Field

Description

hosts

list Requested list of hosts for the cluster.

hosts[]

doublecloud.clickhouse.v1.Host

next_page

doublecloud.v1.NextPage Pagination information of the response

Field

Description

cluster_id

string Required. ID of the ClickHouse cluster.

paging

doublecloud.v1.Paging Paging information of the request

Field

Description

operations

list

operations[]

doublecloud.v1.Operation

next_page

doublecloud.v1.NextPage Pagination information of the response

Field

Description

project_id

string ID of the project to list ClickHouse clusters in.

paging

doublecloud.v1.Paging Paging information of the request

view

doublecloud.clickhouse.v1.ClusterView The level of detail to be returned. If unspecified, defaults to CLUSTER_VIEW_BASIC.

Field

Description

clusters

list List of ClickHouse cluster resources.

clusters[]

doublecloud.clickhouse.v1.Cluster

next_page

doublecloud.v1.NextPage Pagination information of the response

Field

Description

cluster_id

string Required. ID of the ClickHouse cluster to maintenance reschedule.

reschedule_type

doublecloud.v1.RescheduleType Required. The type of reschedule request.

delayed_until_time

google.protobuf.Timestamp The time for SPECIFIC_TIME reschedule. Limited by two weeks since first time scheduled.

Field

Description

cluster_id

string ID of the ClickHouse cluster to reset credentials. To get the ClickHouse cluster ID, use a [ClusterService.List] request.

Field

Description

backup_id

string Required. ID of the backup to restore from.

project_id

string ID of the project to create the ClickHouse cluster in.

region_id

string ID of the region to place instances.

name

string Name of the ClickHouse cluster. The name must be unique within the project.

description

string Description of the ClickHouse cluster.

version

string Version of ClickHouse DBMS.

resources

doublecloud.clickhouse.v1.ClusterResources Resources allocated to the ClickHouse cluster.

access

doublecloud.v1.Access Security settings

encryption

doublecloud.v1.DataEncryption DataEncryption settings

network_id

string ID of the network to create ClickHouse cluster in.

clickhouse_config

doublecloud.clickhouse.v1.ClickhouseConfig ClickHouse server configuration.

maintenance_window

doublecloud.v1.MaintenanceWindow Window of maintenance operations.

Field

Description

cluster_id

string ID of the ClickHouse cluster to start.

Field

Description

cluster_id

string ID of the ClickHouse cluster to stop.

Field

Description

cluster_id

string ID of the ClickHouse cluster resource to update. To get the ClickHouse cluster ID, use a [ClusterService.List] request.

name

string New name for the cluster.

description

string New description of the ClickHouse cluster.

version

string Version of ClickHouse DBMS.

resources

doublecloud.clickhouse.v1.ClusterResources Resources allocated to the ClickHouse cluster.

access

doublecloud.v1.Access Access settings

clickhouse_config

doublecloud.clickhouse.v1.ClickhouseConfig ClickHouse server configuration.

maintenance_window

doublecloud.v1.MaintenanceWindow Window of maintenance operations.

Field

Description

log_level

doublecloud.clickhouse.v1.ClickhouseConfig.LogLevel

max_connections

google.protobuf.Int64Value

max_concurrent_queries

google.protobuf.Int64Value

keep_alive_timeout

google.protobuf.Duration

uncompressed_cache_size

google.protobuf.Int64Value

mark_cache_size

google.protobuf.Int64Value

max_table_size_to_drop

google.protobuf.Int64Value

max_partition_size_to_drop

google.protobuf.Int64Value

timezone

google.protobuf.StringValue

background_pool_size

google.protobuf.Int64Value

background_schedule_pool_size

google.protobuf.Int64Value

background_fetches_pool_size

google.protobuf.Int64Value

background_move_pool_size

google.protobuf.Int64Value

background_common_pool_size

google.protobuf.Int64Value

background_merges_mutations_concurrency_ratio

google.protobuf.Int64Value

total_memory_profiler_step

google.protobuf.Int64Value

total_memory_tracker_sample_probability

google.protobuf.DoubleValue

background_message_broker_schedule_pool_size

google.protobuf.Int64Value

merge_tree

doublecloud.clickhouse.v1.ClickhouseConfig.MergeTree

compression

list

compression[]

doublecloud.clickhouse.v1.ClickhouseConfig.Compression

graphite_rollup

list

graphite_rollup[]

doublecloud.clickhouse.v1.ClickhouseConfig.GraphiteRollupEntry

kafka

doublecloud.clickhouse.v1.ClickhouseConfig.Kafka

kafka_topics

list

kafka_topics[]

doublecloud.clickhouse.v1.ClickhouseConfig.KafkaTopicsEntry

rabbitmq

doublecloud.clickhouse.v1.ClickhouseConfig.Rabbitmq

query_log_retention_size

google.protobuf.Int64Value

query_log_retention_time

google.protobuf.Duration

query_thread_log_enabled

google.protobuf.BoolValue

query_thread_log_retention_size

google.protobuf.Int64Value

query_thread_log_retention_time

google.protobuf.Duration

query_views_log_enabled

google.protobuf.BoolValue

query_views_log_retention_size

google.protobuf.Int64Value

query_views_log_retention_time

google.protobuf.Duration

part_log_retention_size

google.protobuf.Int64Value

part_log_retention_time

google.protobuf.Duration

metric_log_enabled

google.protobuf.BoolValue

metric_log_retention_size

google.protobuf.Int64Value

metric_log_retention_time

google.protobuf.Duration

asynchronous_metric_log_enabled

google.protobuf.BoolValue

asynchronous_metric_log_retention_size

google.protobuf.Int64Value

asynchronous_metric_log_retention_time

google.protobuf.Duration

trace_log_enabled

google.protobuf.BoolValue

trace_log_retention_size

google.protobuf.Int64Value

trace_log_retention_time

google.protobuf.Duration

text_log_enabled

google.protobuf.BoolValue

text_log_retention_size

google.protobuf.Int64Value

text_log_retention_time

google.protobuf.Duration

text_log_level

doublecloud.clickhouse.v1.ClickhouseConfig.LogLevel

opentelemetry_span_log_enabled

google.protobuf.BoolValue

opentelemetry_span_log_retention_size

google.protobuf.Int64Value

opentelemetry_span_log_retention_time

google.protobuf.Duration

session_log_enabled

google.protobuf.BoolValue

session_log_retention_size

google.protobuf.Int64Value

session_log_retention_time

google.protobuf.Duration

zookeeper_log_enabled

google.protobuf.BoolValue

zookeeper_log_retention_size

google.protobuf.Int64Value

zookeeper_log_retention_time

google.protobuf.Duration

asynchronous_insert_log_enabled

google.protobuf.BoolValue

asynchronous_insert_log_retention_size

google.protobuf.Int64Value

asynchronous_insert_log_retention_time

google.protobuf.Duration

Field

Description

method

doublecloud.clickhouse.v1.ClickhouseConfig.Compression.Method

min_part_size

int64

min_part_size_ratio

double

level

google.protobuf.Int64Value

Field

Description

patterns

list

patterns[]

doublecloud.clickhouse.v1.ClickhouseConfig.GraphiteRollup.Pattern

Field

Description

regexp

google.protobuf.StringValue

function

google.protobuf.StringValue

retention

list

retention[]

doublecloud.clickhouse.v1.ClickhouseConfig.GraphiteRollup.Pattern.Retention

Field

Description

age

int64

precision

int64

Field

Description

key

string

value

doublecloud.clickhouse.v1.ClickhouseConfig.GraphiteRollup

Field

Description

security_protocol

doublecloud.clickhouse.v1.ClickhouseConfig.Kafka.SecurityProtocol

sasl_mechanism

doublecloud.clickhouse.v1.ClickhouseConfig.Kafka.SaslMechanism

sasl_username

google.protobuf.StringValue

sasl_password

google.protobuf.StringValue

enable_ssl_certificate_verification

google.protobuf.BoolValue

Field

Description

key

string

value

doublecloud.clickhouse.v1.ClickhouseConfig.Kafka

Field

Description

replicated_deduplication_window

google.protobuf.Int64Value

replicated_deduplication_window_seconds

google.protobuf.Duration

parts_to_delay_insert

google.protobuf.Int64Value

parts_to_throw_insert

google.protobuf.Int64Value

inactive_parts_to_delay_insert

google.protobuf.Int64Value

inactive_parts_to_throw_insert

google.protobuf.Int64Value

max_replicated_merges_in_queue

google.protobuf.Int64Value

number_of_free_entries_in_pool_to_lower_max_size_of_merge

google.protobuf.Int64Value

max_bytes_to_merge_at_min_space_in_pool

google.protobuf.Int64Value

max_bytes_to_merge_at_max_space_in_pool

google.protobuf.Int64Value

min_bytes_for_wide_part

google.protobuf.Int64Value

min_rows_for_wide_part

google.protobuf.Int64Value

ttl_only_drop_parts

google.protobuf.BoolValue

allow_remote_fs_zero_copy_replication

google.protobuf.BoolValue

merge_with_ttl_timeout

google.protobuf.Duration

merge_with_recompression_ttl_timeout

google.protobuf.Duration

max_parts_in_total

google.protobuf.Int64Value

max_number_of_merges_with_ttl_in_pool

google.protobuf.Int64Value

cleanup_delay_period

google.protobuf.Duration

number_of_free_entries_in_pool_to_execute_mutation

google.protobuf.Int64Value

Field

Description

username

google.protobuf.StringValue

password

google.protobuf.StringValue

vhost

google.protobuf.StringValue

Field

Description

operation_id

string Required. ID of the operation to return.

Field

Description

project_id

string ID of the project to list clusters operations in.

paging

doublecloud.v1.Paging Paging information of the request

Field

Description

operations

list List of operations.

operations[]

doublecloud.v1.Operation

next_page

doublecloud.v1.NextPage Pagination information of the response

Field

Description

id

string ID of the version.

name

string Name of the version.

deprecated

bool Whether version is deprecated.

updatable_to

list List of versions that can be updated from current.

updatable_to[]

string

Field

Description

paging

doublecloud.v1.Paging Paging information of the request

Field

Description

versions

list Requested list of available versions.

versions[]

doublecloud.clickhouse.v1.Version

next_page

doublecloud.v1.NextPage Pagination information of the response