ClusterService

A set of methods for managing ClickHouse clusters.

Call Description
Get Returns the specified ClickHouse cluster.
List Retrieves a list of ClickHouse clusters that belong to the specified folder.
Create Creates a ClickHouse cluster in the specified folder.
Update Updates the specified ClickHouse cluster.
Delete Deletes the specified ClickHouse cluster.
Start Starts the specified ClickHouse cluster.
Stop Stops the specified ClickHouse cluster.
Move Moves a ClickHouse cluster to the specified folder.
AddZookeeper Adds a ZooKeeper subcluster to the specified ClickHouse cluster.
Backup Creates a backup for the specified ClickHouse cluster.
Restore Creates a new ClickHouse cluster using the specified backup.
ListLogs Retrieves logs for the specified ClickHouse cluster.
ListOperations Retrieves the list of Operation resources for the specified cluster.
ListBackups Retrieves the list of available backups for the specified ClickHouse cluster.
ListHosts Retrieves a list of hosts for the specified cluster.
AddHosts Creates new hosts for a cluster.
DeleteHosts Deletes the specified hosts for a cluster.
GetShard Returns the specified shard.
ListShards Retrieves a list of shards that belong to the specified cluster.
AddShard Creates a new shard in the specified cluster.
UpdateShard Modifies the specified shard.
DeleteShard Deletes the specified shard.
CreateExternalDictionary Creates an external dictionary for the specified ClickHouse cluster.
DeleteExternalDictionary Deletes the specified external dictionary.

Calls ClusterService

Get

Returns the specified ClickHouse cluster.
To get the list of available ClickHouse clusters, make a List request.

rpc Get (GetClusterRequest) returns (Cluster)

GetClusterRequest

Field Description
cluster_id string
Required. ID of the ClickHouse Cluster resource to return. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.

Cluster

Field Description
id string
ID of the ClickHouse cluster. This ID is assigned by MDB at creation time.
folder_id string
ID of the folder that the ClickHouse cluster belongs to.
created_at google.protobuf.Timestamp
Creation timestamp in RFC3339 text format.
name string
Name of the ClickHouse cluster. The name is unique within the folder. 1-63 characters long.
description string
Description of the ClickHouse cluster. 0-256 characters long.
labels map<string,string>
Custom labels for the ClickHouse cluster as key:value pairs. Maximum 64 per resource.
environment enum Environment
Deployment environment of the ClickHouse cluster.
  • PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.
  • PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
    monitoring[] Monitoring
    Description of monitoring systems relevant to the ClickHouse cluster.
    config ClusterConfig
    Configuration of the ClickHouse cluster.
    network_id string
    ID of the network that the cluster belongs to.
    health enum Health
    Aggregated cluster health.
    • HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN).
    • ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE).
    • DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD).
    • DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
      status enum Status
      Current state of the cluster.
      • STATUS_UNKNOWN: Cluster state is unknown.
      • CREATING: Cluster is being created.
      • RUNNING: Cluster is running normally.
      • ERROR: Cluster encountered a problem and cannot operate.
      • UPDATING: Cluster is being updated.
      • STOPPING: Cluster is stopping.
      • STOPPED: Cluster stopped.
      • STARTING: Cluster is starting.

        Monitoring

        Field Description
        name string
        Name of the monitoring system.
        description string
        Description of the monitoring system.
        link string
        Link to the monitoring system charts for the ClickHouse cluster.

        ClusterConfig

        Field Description
        version string
        Version of the ClickHouse server software.
        clickhouse Clickhouse
        Configuration and resource allocation for ClickHouse hosts.
        zookeeper Zookeeper
        Configuration and resource allocation for ZooKeeper hosts.
        backup_window_start google.type.TimeOfDay
        Time to start the daily backup, in the UTC timezone.
        access Access
        Access policy to DB

        Clickhouse

        Field Description
        config config.ClickhouseConfigSet
        Configuration settings of a ClickHouse server.
        resources Resources
        Resources allocated to ClickHouse hosts.

        Zookeeper

        Field Description
        resources Resources
        Resources allocated to ZooKeeper hosts.

        Access

        Field Description
        data_lens bool
        Allow access for DataLens
        web_sql bool
        Allow access for Web SQL

        List

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

        rpc List (ListClustersRequest) returns (ListClustersResponse)

        ListClustersRequest

        Field Description
        folder_id string
        Required. ID of the folder to list ClickHouse clusters in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
        page_size int64
        The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClustersResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
        page_token string
        Page token. To get the next page of results, set page_token to the ListClustersResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
        filter string
        1. The field name. Currently you can only use filtering with the Cluster.name field.
        2. An operator. Can be either = or != for single values, IN or NOT IN for lists of values.
        3. The value. Мust be 1-63 characters long and match the regular expression ^[a-zA-Z0-9_-]+$.
        The maximum string length in characters is 1000.

        ListClustersResponse

        Field Description
        clusters[] Cluster
        List of ClickHouse Cluster resources.
        next_page_token string
        This token allows you to get the next page of results for list requests. If the number of results is larger than ListClustersRequest.page_size, use the next_page_token as the value for the ListClustersRequest.page_token parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

        Cluster

        Field Description
        id string
        ID of the ClickHouse cluster. This ID is assigned by MDB at creation time.
        folder_id string
        ID of the folder that the ClickHouse cluster belongs to.
        created_at google.protobuf.Timestamp
        Creation timestamp in RFC3339 text format.
        name string
        Name of the ClickHouse cluster. The name is unique within the folder. 1-63 characters long.
        description string
        Description of the ClickHouse cluster. 0-256 characters long.
        labels map<string,string>
        Custom labels for the ClickHouse cluster as key:value pairs. Maximum 64 per resource.
        environment enum Environment
        Deployment environment of the ClickHouse cluster.
        • PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.
        • PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
          monitoring[] Monitoring
          Description of monitoring systems relevant to the ClickHouse cluster.
          config ClusterConfig
          Configuration of the ClickHouse cluster.
          network_id string
          ID of the network that the cluster belongs to.
          health enum Health
          Aggregated cluster health.
          • HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN).
          • ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE).
          • DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD).
          • DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
            status enum Status
            Current state of the cluster.
            • STATUS_UNKNOWN: Cluster state is unknown.
            • CREATING: Cluster is being created.
            • RUNNING: Cluster is running normally.
            • ERROR: Cluster encountered a problem and cannot operate.
            • UPDATING: Cluster is being updated.
            • STOPPING: Cluster is stopping.
            • STOPPED: Cluster stopped.
            • STARTING: Cluster is starting.

              Monitoring

              Field Description
              name string
              Name of the monitoring system.
              description string
              Description of the monitoring system.
              link string
              Link to the monitoring system charts for the ClickHouse cluster.

              ClusterConfig

              Field Description
              version string
              Version of the ClickHouse server software.
              clickhouse Clickhouse
              Configuration and resource allocation for ClickHouse hosts.
              zookeeper Zookeeper
              Configuration and resource allocation for ZooKeeper hosts.
              backup_window_start google.type.TimeOfDay
              Time to start the daily backup, in the UTC timezone.
              access Access
              Access policy to DB

              Clickhouse

              Field Description
              config config.ClickhouseConfigSet
              Configuration settings of a ClickHouse server.
              resources Resources
              Resources allocated to ClickHouse hosts.

              Zookeeper

              Field Description
              resources Resources
              Resources allocated to ZooKeeper hosts.

              Access

              Field Description
              data_lens bool
              Allow access for DataLens
              web_sql bool
              Allow access for Web SQL

              Create

              Creates a ClickHouse cluster in the specified folder.

              rpc Create (CreateClusterRequest) returns (operation.Operation)

              Metadata and response of Operation:
                  Operation.metadata:CreateClusterMetadata
                  Operation.response:Cluster

              CreateClusterRequest

              Field Description
              folder_id string
              Required. ID of the folder to create the ClickHouse cluster in. The maximum string length in characters is 50.
              name string
              Required. Name of the ClickHouse cluster. The name must be unique within the folder. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
              description string
              Description of the ClickHouse cluster. The maximum string length in characters is 256.
              labels map<string,string>
              Custom labels for the ClickHouse cluster as key:value pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary". No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The maximum string length in characters for each key is 63. Each key must match the regular expression [a-z][-_0-9a-z]*.
              environment Cluster.Environment
              Required. Deployment environment of the ClickHouse cluster.
              config_spec ConfigSpec
              Required. Configuration and resources for hosts that should be created for the ClickHouse cluster.
              database_specs[] DatabaseSpec
              Descriptions of databases to be created in the ClickHouse cluster. The number of elements must be greater than 0.
              user_specs[] UserSpec
              Descriptions of database users to be created in the ClickHouse cluster. The number of elements must be greater than 0.
              host_specs[] HostSpec
              Individual configurations for hosts that should be created for the ClickHouse cluster. The number of elements must be greater than 0.
              network_id string
              Required. ID of the network to create the cluster in. The maximum string length in characters is 50.
              shard_name string
              Name of the first shard in cluster. If not set, defaults to the value 'shard1'. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

              ConfigSpec

              Field Description
              version string
              Version of the ClickHouse server software.
              clickhouse Clickhouse
              Configuration and resources for a ClickHouse server.
              zookeeper Zookeeper
              Configuration and resources for a ZooKeeper server.
              backup_window_start google.type.TimeOfDay
              Time to start the daily backup, in the UTC timezone.
              access Access
              Access policy to DB

              Clickhouse

              Field Description
              config config.ClickhouseConfig
              Configuration for a ClickHouse server.
              resources Resources
              Resources allocated to ClickHouse hosts.

              Zookeeper

              Field Description
              resources Resources
              Resources allocated to ZooKeeper hosts. If not set, minimal available resources will be used. All available resource presets can be retrieved with a ResourcePresetService.List request.

              Access

              Field Description
              data_lens bool
              Allow access for DataLens
              web_sql bool
              Allow access for Web SQL

              DatabaseSpec

              Field Description
              name string
              Required. Name of the ClickHouse database. 1-63 characters long. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

              UserSpec

              Field Description
              name string
              Required. Name of the ClickHouse user. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_]*.
              password string
              Required. Password of the ClickHouse user. The string length in characters must be 8-128.
              permissions[] Permission
              Set of permissions to grant to the user.
              settings UserSettings
              quotas[] UserQuota
              Set of quotas assigned to the user.

              Permission

              Field Description
              database_name string
              Name of the database that the permission grants access to.
              data_filters[] DataFilter

              DataFilter

              Field Description
              table_name string
              filter string

              UserSettings

              Field Description
              readonly google.protobuf.Int64Value
              • 0 (default) — no restrictions.
              • 1 — only read data queries are allowed.
              • 2 — read data and change settings queries are allowed.
              Acceptable values are 0 to 2, inclusive.
              allow_ddl google.protobuf.BoolValue
              Whether DDL queries are allowed. Default value: false. See in-depth description in ClickHouse documentation.
              insert_quorum google.protobuf.Int64Value
              See in-depth description in ClickHouse documentation. The minimum value is 0.
              connect_timeout google.protobuf.Int64Value
              Connection timeout in milliseconds. See in-depth description in ClickHouse documentation. Value must be greater than 0.
              receive_timeout google.protobuf.Int64Value
              Receive timeout in milliseconds. See in-depth description in ClickHouse documentation. Value must be greater than 0.
              send_timeout google.protobuf.Int64Value
              Send timeout in milliseconds. See in-depth description in ClickHouse documentation. Value must be greater than 0.
              insert_quorum_timeout google.protobuf.Int64Value
              The minimum value is 1000.
              select_sequential_consistency google.protobuf.BoolValue
              See in-depth description in ClickHouse documentation.
              max_replica_delay_for_distributed_queries google.protobuf.Int64Value
              The minimum value is 1000.
              fallback_to_stale_replicas_for_distributed_queries google.protobuf.BoolValue
              See in-depth description in ClickHouse documentation.
              replication_alter_partitions_sync google.protobuf.Int64Value
              See in-depth description in ClickHouse documentation. Acceptable values are 0 to 2, inclusive.
              distributed_product_mode enum DistributedProductMode
              See in-depth description in ClickHouse documentation.
                distributed_aggregation_memory_efficient google.protobuf.BoolValue
                Whether the memory-saving mode of distributed aggregation is enabled.
                distributed_ddl_task_timeout google.protobuf.Int64Value
                Timeout for DDL queries, in milliseconds.
                compile google.protobuf.BoolValue
                Whether query compilation is enabled. See in-depth description in ClickHouse documentation.
                min_count_to_compile google.protobuf.Int64Value
                The number of structurally identical queries before they are compiled. See in-depth description in ClickHouse documentation. The minimum value is 0.
                compile_expressions google.protobuf.BoolValue
                Whether expression compilation is enabled.
                min_count_to_compile_expression google.protobuf.Int64Value
                The number of identical expressions before they are compiled. The minimum value is 0.
                max_block_size google.protobuf.Int64Value
                See in-depth description in ClickHouse documentation. Value must be greater than 0.
                min_insert_block_size_rows google.protobuf.Int64Value
                Squash blocks passed to INSERT query to specified size in rows, if blocks are not big enough. If set to 0, blocks will never be squashed. The minimum value is 0.
                min_insert_block_size_bytes google.protobuf.Int64Value
                Squash blocks passed to INSERT query to specified size in bytes, if blocks are not big enough. If set to 0, blocks will never be squashed. The minimum value is 0.
                max_insert_block_size google.protobuf.Int64Value
                See in-depth description in ClickHouse documentation. Value must be greater than 0.
                min_bytes_to_use_direct_io google.protobuf.Int64Value
                See in-depth description in ClickHouse documentation. The minimum value is 0.
                use_uncompressed_cache google.protobuf.BoolValue
                See in-depth description in ClickHouse documentation.
                merge_tree_max_rows_to_use_cache google.protobuf.Int64Value
                The maximum request size in rows to use the cache of uncompressed data. The cache is not used for requests larger than the specified value. See in-depth description in ClickHouse documentation. Value must be greater than 0.
                merge_tree_max_bytes_to_use_cache google.protobuf.Int64Value
                The maximum request size in bytes to use the cache of uncompressed data. The cache is not used for requests larger than the specified value. Value must be greater than 0.
                merge_tree_min_rows_for_concurrent_read google.protobuf.Int64Value
                The minimum number of rows to be read from a file to enable concurrent read. See in-depth description in ClickHouse documentation. Value must be greater than 0.
                merge_tree_min_bytes_for_concurrent_read google.protobuf.Int64Value
                The minimum number of bytes to be read from a file to enable concurrent read. Value must be greater than 0.
                max_bytes_before_external_group_by google.protobuf.Int64Value
                max_bytes_before_external_sort google.protobuf.Int64Value
                group_by_two_level_threshold google.protobuf.Int64Value
                group_by_two_level_threshold_bytes google.protobuf.Int64Value
                priority google.protobuf.Int64Value
                Priority of the query. The minimum value is 0.
                max_threads google.protobuf.Int64Value
                See in-depth description in ClickHouse documentation. Value must be greater than 0.
                max_memory_usage google.protobuf.Int64Value
                See in-depth description in ClickHouse documentation. The minimum value is 0.
                max_memory_usage_for_user google.protobuf.Int64Value
                See in-depth description in ClickHouse documentation. The minimum value is 0.
                max_network_bandwidth google.protobuf.Int64Value
                See in-depth description in ClickHouse documentation.
                max_network_bandwidth_for_user google.protobuf.Int64Value
                See in-depth description in ClickHouse documentation.
                force_index_by_date google.protobuf.BoolValue
                See in-depth description in ClickHouse documentation.
                force_primary_key google.protobuf.BoolValue
                See in-depth description in ClickHouse documentation.
                max_rows_to_read google.protobuf.Int64Value
                See in-depth description in ClickHouse documentation. The minimum value is 0.
                max_bytes_to_read google.protobuf.Int64Value
                See in-depth description in ClickHouse documentation. The minimum value is 0.
                read_overflow_mode enum OverflowMode
                See in-depth description in ClickHouse documentation.
                  max_rows_to_group_by google.protobuf.Int64Value
                  See in-depth description in ClickHouse documentation. The minimum value is 0.
                  group_by_overflow_mode enum GroupByOverflowMode
                  See in-depth description in ClickHouse documentation.
                    max_rows_to_sort google.protobuf.Int64Value
                    See in-depth description in ClickHouse documentation. The minimum value is 0.
                    max_bytes_to_sort google.protobuf.Int64Value
                    See in-depth description in ClickHouse documentation. The minimum value is 0.
                    sort_overflow_mode enum OverflowMode
                    See in-depth description in ClickHouse documentation.
                      max_result_rows google.protobuf.Int64Value
                      See in-depth description in ClickHouse documentation. The minimum value is 0.
                      max_result_bytes google.protobuf.Int64Value
                      See in-depth description in ClickHouse documentation. The minimum value is 0.
                      result_overflow_mode enum OverflowMode
                      See in-depth description in ClickHouse documentation.
                        max_rows_in_distinct google.protobuf.Int64Value
                        See in-depth description in ClickHouse documentation. The minimum value is 0.
                        max_bytes_in_distinct google.protobuf.Int64Value
                        See in-depth description in ClickHouse documentation. The minimum value is 0.
                        distinct_overflow_mode enum OverflowMode
                        See in-depth description in ClickHouse documentation.
                          max_rows_to_transfer google.protobuf.Int64Value
                          See in-depth description in ClickHouse documentation. The minimum value is 0.
                          max_bytes_to_transfer google.protobuf.Int64Value
                          See in-depth description in ClickHouse documentation. The minimum value is 0.
                          transfer_overflow_mode enum OverflowMode
                          See in-depth description in ClickHouse documentation.
                            max_execution_time google.protobuf.Int64Value
                            Maximum query execution time in milliseconds. See in-depth description in ClickHouse documentation. The minimum value is 0.
                            timeout_overflow_mode enum OverflowMode
                            See in-depth description in ClickHouse documentation.
                              max_columns_to_read google.protobuf.Int64Value
                              Maximum number of columns that can be read from a table in a single query. See in-depth description in ClickHouse documentation. The minimum value is 0.
                              max_temporary_columns google.protobuf.Int64Value
                              Maximum number of temporary columns that must be kept in RAM at the same time when running a query, including constant columns. See in-depth description in ClickHouse documentation. The minimum value is 0.
                              max_temporary_non_const_columns google.protobuf.Int64Value
                              Maximum number of temporary columns that must be kept in RAM at the same time when running a query, excluding constant columns. See in-depth description in ClickHouse documentation. The minimum value is 0.
                              max_query_size google.protobuf.Int64Value
                              Value must be greater than 0.
                              max_ast_depth google.protobuf.Int64Value
                              Value must be greater than 0.
                              max_ast_elements google.protobuf.Int64Value
                              Value must be greater than 0.
                              max_expanded_ast_elements google.protobuf.Int64Value
                              Maximum size of query syntax tree in number of nodes after expansion of aliases and the asterisk. Default value: 500000. Value must be greater than 0.
                              input_format_values_interpret_expressions google.protobuf.BoolValue
                              See in-depth description in ClickHouse documentation.
                              input_format_defaults_for_omitted_fields google.protobuf.BoolValue
                              See in-depth description in ClickHouse documentation.
                              output_format_json_quote_64bit_integers google.protobuf.BoolValue
                              Whether quoting of 64-bit integers is enabled in JSON output format. See in-depth description in ClickHouse documentation.
                              output_format_json_quote_denormals google.protobuf.BoolValue
                              Whether output of special floating-point values (+nan, -nan, +inf and -inf) is enabled in JSON output format.
                              low_cardinality_allow_in_native_format google.protobuf.BoolValue
                              empty_result_for_aggregation_by_empty_set google.protobuf.BoolValue
                              http_connection_timeout google.protobuf.Int64Value
                              HTTP connection timeout, in milliseconds.
                              http_receive_timeout google.protobuf.Int64Value
                              HTTP receive timeout, in milliseconds.
                              http_send_timeout google.protobuf.Int64Value
                              HTTP send timeout, in milliseconds.
                              enable_http_compression google.protobuf.BoolValue
                              See in-depth description in ClickHouse documentation.
                              send_progress_in_http_headers google.protobuf.BoolValue
                              Whether progress notifications using X-ClickHouse-Progress headers are enabled. Default value: false. See in-depth description in ClickHouse documentation.
                              http_headers_progress_interval google.protobuf.Int64Value
                              Minimum interval between progress notifications, in milliseconds. Default value: 100.
                              add_http_cors_header google.protobuf.BoolValue
                              Whether CORS header in HTTP responses is enabled. Default value: false.

                              UserQuota

                              Field Description
                              interval_duration google.protobuf.Int64Value
                              Duration of interval for quota in milliseconds. Minimal value is 1 minute. The minimum value is 60000.
                              queries google.protobuf.Int64Value
                              The total number of queries. 0 - unlimited. The minimum value is 0.
                              errors google.protobuf.Int64Value
                              The number of queries that threw exception. 0 - unlimited. The minimum value is 0.
                              result_rows google.protobuf.Int64Value
                              The total number of rows given as the result.. 0 - unlimited. The minimum value is 0.
                              read_rows google.protobuf.Int64Value
                              The total number of source rows read from tables for running the query, on all remote servers. 0 - unlimited. The minimum value is 0.
                              execution_time google.protobuf.Int64Value
                              The total query execution time, in milliseconds (wall time). 0 - unlimited. The minimum value is 0.

                              HostSpec

                              Field Description
                              zone_id string
                              ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50.
                              type Host.Type
                              Required. Type of the host to be deployed.
                              subnet_id string
                              ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the Cluster.network_id field. The maximum string length in characters is 50.
                              assign_public_ip bool
                              • false — don't assign a public IP to the host.
                              • true — the host should have a public IP address.
                              shard_name string
                              Name of the shard that the host is assigned to. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

                              Operation

                              Field Description
                              id string
                              ID of the operation.
                              description string
                              Description of the operation. 0-256 characters long.
                              created_at google.protobuf.Timestamp
                              Creation timestamp.
                              created_by string
                              ID of the user or service account who initiated the operation.
                              modified_at google.protobuf.Timestamp
                              The time when the Operation resource was last modified.
                              done bool
                              If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
                              metadata google.protobuf.Any<CreateClusterMetadata>
                              Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
                              result oneof: error or response
                              The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
                                error google.rpc.Status
                              The error result of the operation in case of failure or cancellation.
                                response google.protobuf.Any<Cluster>
                              if operation finished successfully.

                              CreateClusterMetadata

                              Field Description
                              cluster_id string
                              ID of the ClickHouse cluster that is being created.

                              Cluster

                              Field Description
                              id string
                              ID of the ClickHouse cluster. This ID is assigned by MDB at creation time.
                              folder_id string
                              ID of the folder that the ClickHouse cluster belongs to.
                              created_at google.protobuf.Timestamp
                              Creation timestamp in RFC3339 text format.
                              name string
                              Name of the ClickHouse cluster. The name is unique within the folder. 1-63 characters long.
                              description string
                              Description of the ClickHouse cluster. 0-256 characters long.
                              labels map<string,string>
                              Custom labels for the ClickHouse cluster as key:value pairs. Maximum 64 per resource.
                              environment enum Environment
                              Deployment environment of the ClickHouse cluster.
                              • PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.
                              • PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
                                monitoring[] Monitoring
                                Description of monitoring systems relevant to the ClickHouse cluster.
                                config ClusterConfig
                                Configuration of the ClickHouse cluster.
                                network_id string
                                ID of the network that the cluster belongs to.
                                health enum Health
                                Aggregated cluster health.
                                • HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN).
                                • ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE).
                                • DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD).
                                • DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
                                  status enum Status
                                  Current state of the cluster.
                                  • STATUS_UNKNOWN: Cluster state is unknown.
                                  • CREATING: Cluster is being created.
                                  • RUNNING: Cluster is running normally.
                                  • ERROR: Cluster encountered a problem and cannot operate.
                                  • UPDATING: Cluster is being updated.
                                  • STOPPING: Cluster is stopping.
                                  • STOPPED: Cluster stopped.
                                  • STARTING: Cluster is starting.

                                    Update

                                    Updates the specified ClickHouse cluster.

                                    rpc Update (UpdateClusterRequest) returns (operation.Operation)

                                    Metadata and response of Operation:
                                        Operation.metadata:UpdateClusterMetadata
                                        Operation.response:Cluster

                                    UpdateClusterRequest

                                    Field Description
                                    cluster_id string
                                    Required. ID of the ClickHouse Cluster resource to update. To get the ClickHouse cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
                                    update_mask google.protobuf.FieldMask
                                    Field mask that specifies which fields of the ClickHouse Cluster resource should be updated.
                                    description string
                                    New description of the ClickHouse cluster. The maximum string length in characters is 256.
                                    labels map<string,string>
                                    Custom labels for the ClickHouse cluster as key:value pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary".
                                    The new set of labels will completely replace the old ones. To add a label, request the current set with the ClusterService.Get method, then send an ClusterService.Update request with the new label added to the set. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The maximum string length in characters for each key is 63. Each key must match the regular expression [a-z][-_0-9a-z]*.
                                    config_spec ConfigSpec
                                    New configuration and resources for hosts in the cluster.
                                    name string
                                    New name for the cluster. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

                                    ConfigSpec

                                    Field Description
                                    version string
                                    Version of the ClickHouse server software.
                                    clickhouse Clickhouse
                                    Configuration and resources for a ClickHouse server.
                                    zookeeper Zookeeper
                                    Configuration and resources for a ZooKeeper server.
                                    backup_window_start google.type.TimeOfDay
                                    Time to start the daily backup, in the UTC timezone.
                                    access Access
                                    Access policy to DB

                                    Clickhouse

                                    Field Description
                                    config config.ClickhouseConfig
                                    Configuration for a ClickHouse server.
                                    resources Resources
                                    Resources allocated to ClickHouse hosts.

                                    Zookeeper

                                    Field Description
                                    resources Resources
                                    Resources allocated to ZooKeeper hosts. If not set, minimal available resources will be used. All available resource presets can be retrieved with a ResourcePresetService.List request.

                                    Access

                                    Field Description
                                    data_lens bool
                                    Allow access for DataLens
                                    web_sql bool
                                    Allow access for Web SQL

                                    Operation

                                    Field Description
                                    id string
                                    ID of the operation.
                                    description string
                                    Description of the operation. 0-256 characters long.
                                    created_at google.protobuf.Timestamp
                                    Creation timestamp.
                                    created_by string
                                    ID of the user or service account who initiated the operation.
                                    modified_at google.protobuf.Timestamp
                                    The time when the Operation resource was last modified.
                                    done bool
                                    If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
                                    metadata google.protobuf.Any<UpdateClusterMetadata>
                                    Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
                                    result oneof: error or response
                                    The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
                                      error google.rpc.Status
                                    The error result of the operation in case of failure or cancellation.
                                      response google.protobuf.Any<Cluster>
                                    if operation finished successfully.

                                    UpdateClusterMetadata

                                    Field Description
                                    cluster_id string
                                    ID of the ClickHouse Cluster resource that is being updated.

                                    Cluster

                                    Field Description
                                    id string
                                    ID of the ClickHouse cluster. This ID is assigned by MDB at creation time.
                                    folder_id string
                                    ID of the folder that the ClickHouse cluster belongs to.
                                    created_at google.protobuf.Timestamp
                                    Creation timestamp in RFC3339 text format.
                                    name string
                                    Name of the ClickHouse cluster. The name is unique within the folder. 1-63 characters long.
                                    description string
                                    Description of the ClickHouse cluster. 0-256 characters long.
                                    labels map<string,string>
                                    Custom labels for the ClickHouse cluster as key:value pairs. Maximum 64 per resource.
                                    environment enum Environment
                                    Deployment environment of the ClickHouse cluster.
                                    • PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.
                                    • PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
                                      monitoring[] Monitoring
                                      Description of monitoring systems relevant to the ClickHouse cluster.
                                      config ClusterConfig
                                      Configuration of the ClickHouse cluster.
                                      network_id string
                                      ID of the network that the cluster belongs to.
                                      health enum Health
                                      Aggregated cluster health.
                                      • HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN).
                                      • ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE).
                                      • DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD).
                                      • DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
                                        status enum Status
                                        Current state of the cluster.
                                        • STATUS_UNKNOWN: Cluster state is unknown.
                                        • CREATING: Cluster is being created.
                                        • RUNNING: Cluster is running normally.
                                        • ERROR: Cluster encountered a problem and cannot operate.
                                        • UPDATING: Cluster is being updated.
                                        • STOPPING: Cluster is stopping.
                                        • STOPPED: Cluster stopped.
                                        • STARTING: Cluster is starting.

                                          Delete

                                          Deletes the specified ClickHouse cluster.

                                          rpc Delete (DeleteClusterRequest) returns (operation.Operation)

                                          Metadata and response of Operation:
                                              Operation.metadata:DeleteClusterMetadata
                                              Operation.response:google.protobuf.Empty

                                          DeleteClusterRequest

                                          Field Description
                                          cluster_id string
                                          Required. ID of the ClickHouse cluster to delete. To get the ClickHouse cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.

                                          Operation

                                          Field Description
                                          id string
                                          ID of the operation.
                                          description string
                                          Description of the operation. 0-256 characters long.
                                          created_at google.protobuf.Timestamp
                                          Creation timestamp.
                                          created_by string
                                          ID of the user or service account who initiated the operation.
                                          modified_at google.protobuf.Timestamp
                                          The time when the Operation resource was last modified.
                                          done bool
                                          If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
                                          metadata google.protobuf.Any<DeleteClusterMetadata>
                                          Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
                                          result oneof: error or response
                                          The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
                                            error google.rpc.Status
                                          The error result of the operation in case of failure or cancellation.
                                            response google.protobuf.Any<google.protobuf.Empty>
                                          if operation finished successfully.

                                          DeleteClusterMetadata

                                          Field Description
                                          cluster_id string
                                          ID of the ClickHouse cluster that is being deleted.

                                          Start

                                          Starts the specified ClickHouse cluster.

                                          rpc Start (StartClusterRequest) returns (operation.Operation)

                                          Metadata and response of Operation:
                                              Operation.metadata:StartClusterMetadata
                                              Operation.response:Cluster

                                          StartClusterRequest

                                          Field Description
                                          cluster_id string
                                          Required. ID of the ClickHouse cluster to start. The maximum string length in characters is 50.

                                          Operation

                                          Field Description
                                          id string
                                          ID of the operation.
                                          description string
                                          Description of the operation. 0-256 characters long.
                                          created_at google.protobuf.Timestamp
                                          Creation timestamp.
                                          created_by string
                                          ID of the user or service account who initiated the operation.
                                          modified_at google.protobuf.Timestamp
                                          The time when the Operation resource was last modified.
                                          done bool
                                          If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
                                          metadata google.protobuf.Any<StartClusterMetadata>
                                          Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
                                          result oneof: error or response
                                          The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
                                            error google.rpc.Status
                                          The error result of the operation in case of failure or cancellation.
                                            response google.protobuf.Any<Cluster>
                                          if operation finished successfully.

                                          StartClusterMetadata

                                          Field Description
                                          cluster_id string
                                          ID of the ClickHouse cluster being started.

                                          Cluster

                                          Field Description
                                          id string
                                          ID of the ClickHouse cluster. This ID is assigned by MDB at creation time.
                                          folder_id string
                                          ID of the folder that the ClickHouse cluster belongs to.
                                          created_at google.protobuf.Timestamp
                                          Creation timestamp in RFC3339 text format.
                                          name string
                                          Name of the ClickHouse cluster. The name is unique within the folder. 1-63 characters long.
                                          description string
                                          Description of the ClickHouse cluster. 0-256 characters long.
                                          labels map<string,string>
                                          Custom labels for the ClickHouse cluster as key:value pairs. Maximum 64 per resource.
                                          environment enum Environment
                                          Deployment environment of the ClickHouse cluster.
                                          • PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.
                                          • PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
                                            monitoring[] Monitoring
                                            Description of monitoring systems relevant to the ClickHouse cluster.
                                            config ClusterConfig
                                            Configuration of the ClickHouse cluster.
                                            network_id string
                                            ID of the network that the cluster belongs to.
                                            health enum Health
                                            Aggregated cluster health.
                                            • HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN).
                                            • ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE).
                                            • DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD).
                                            • DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
                                              status enum Status
                                              Current state of the cluster.
                                              • STATUS_UNKNOWN: Cluster state is unknown.
                                              • CREATING: Cluster is being created.
                                              • RUNNING: Cluster is running normally.
                                              • ERROR: Cluster encountered a problem and cannot operate.
                                              • UPDATING: Cluster is being updated.
                                              • STOPPING: Cluster is stopping.
                                              • STOPPED: Cluster stopped.
                                              • STARTING: Cluster is starting.

                                                Stop

                                                Stops the specified ClickHouse cluster.

                                                rpc Stop (StopClusterRequest) returns (operation.Operation)

                                                Metadata and response of Operation:
                                                    Operation.metadata:StopClusterMetadata
                                                    Operation.response:Cluster

                                                StopClusterRequest

                                                Field Description
                                                cluster_id string
                                                Required. ID of the ClickHouse cluster to stop. The maximum string length in characters is 50.

                                                Operation

                                                Field Description
                                                id string
                                                ID of the operation.
                                                description string
                                                Description of the operation. 0-256 characters long.
                                                created_at google.protobuf.Timestamp
                                                Creation timestamp.
                                                created_by string
                                                ID of the user or service account who initiated the operation.
                                                modified_at google.protobuf.Timestamp
                                                The time when the Operation resource was last modified.
                                                done bool
                                                If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
                                                metadata google.protobuf.Any<StopClusterMetadata>
                                                Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
                                                result oneof: error or response
                                                The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
                                                  error google.rpc.Status
                                                The error result of the operation in case of failure or cancellation.
                                                  response google.protobuf.Any<Cluster>
                                                if operation finished successfully.

                                                StopClusterMetadata

                                                Field Description
                                                cluster_id string
                                                ID of the ClickHouse cluster being stopped.

                                                Cluster

                                                Field Description
                                                id string
                                                ID of the ClickHouse cluster. This ID is assigned by MDB at creation time.
                                                folder_id string
                                                ID of the folder that the ClickHouse cluster belongs to.
                                                created_at google.protobuf.Timestamp
                                                Creation timestamp in RFC3339 text format.
                                                name string
                                                Name of the ClickHouse cluster. The name is unique within the folder. 1-63 characters long.
                                                description string
                                                Description of the ClickHouse cluster. 0-256 characters long.
                                                labels map<string,string>
                                                Custom labels for the ClickHouse cluster as key:value pairs. Maximum 64 per resource.
                                                environment enum Environment
                                                Deployment environment of the ClickHouse cluster.
                                                • PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.
                                                • PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
                                                  monitoring[] Monitoring
                                                  Description of monitoring systems relevant to the ClickHouse cluster.
                                                  config ClusterConfig
                                                  Configuration of the ClickHouse cluster.
                                                  network_id string
                                                  ID of the network that the cluster belongs to.
                                                  health enum Health
                                                  Aggregated cluster health.
                                                  • HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN).
                                                  • ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE).
                                                  • DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD).
                                                  • DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
                                                    status enum Status
                                                    Current state of the cluster.
                                                    • STATUS_UNKNOWN: Cluster state is unknown.
                                                    • CREATING: Cluster is being created.
                                                    • RUNNING: Cluster is running normally.
                                                    • ERROR: Cluster encountered a problem and cannot operate.
                                                    • UPDATING: Cluster is being updated.
                                                    • STOPPING: Cluster is stopping.
                                                    • STOPPED: Cluster stopped.
                                                    • STARTING: Cluster is starting.

                                                      Move

                                                      Moves a ClickHouse cluster to the specified folder.

                                                      rpc Move (MoveClusterRequest) returns (operation.Operation)

                                                      Metadata and response of Operation:
                                                          Operation.metadata:MoveClusterMetadata
                                                          Operation.response:Cluster

                                                      MoveClusterRequest

                                                      Field Description
                                                      cluster_id string
                                                      Required. ID of the ClickHouse cluster to move. The maximum string length in characters is 50.
                                                      destination_folder_id string
                                                      Required. ID of the destination folder. The maximum string length in characters is 50.

                                                      Operation

                                                      Field Description
                                                      id string
                                                      ID of the operation.
                                                      description string
                                                      Description of the operation. 0-256 characters long.
                                                      created_at google.protobuf.Timestamp
                                                      Creation timestamp.
                                                      created_by string
                                                      ID of the user or service account who initiated the operation.
                                                      modified_at google.protobuf.Timestamp
                                                      The time when the Operation resource was last modified.
                                                      done bool
                                                      If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
                                                      metadata google.protobuf.Any<MoveClusterMetadata>
                                                      Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
                                                      result oneof: error or response
                                                      The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
                                                        error google.rpc.Status
                                                      The error result of the operation in case of failure or cancellation.
                                                        response google.protobuf.Any<Cluster>
                                                      if operation finished successfully.

                                                      MoveClusterMetadata

                                                      Field Description
                                                      cluster_id string
                                                      ID of the ClickHouse cluster being moved.
                                                      source_folder_id string
                                                      ID of the source folder.
                                                      destination_folder_id string
                                                      ID of the destination folder.

                                                      Cluster

                                                      Field Description
                                                      id string
                                                      ID of the ClickHouse cluster. This ID is assigned by MDB at creation time.
                                                      folder_id string
                                                      ID of the folder that the ClickHouse cluster belongs to.
                                                      created_at google.protobuf.Timestamp
                                                      Creation timestamp in RFC3339 text format.
                                                      name string
                                                      Name of the ClickHouse cluster. The name is unique within the folder. 1-63 characters long.
                                                      description string
                                                      Description of the ClickHouse cluster. 0-256 characters long.
                                                      labels map<string,string>
                                                      Custom labels for the ClickHouse cluster as key:value pairs. Maximum 64 per resource.
                                                      environment enum Environment
                                                      Deployment environment of the ClickHouse cluster.
                                                      • PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.
                                                      • PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
                                                        monitoring[] Monitoring
                                                        Description of monitoring systems relevant to the ClickHouse cluster.
                                                        config ClusterConfig
                                                        Configuration of the ClickHouse cluster.
                                                        network_id string
                                                        ID of the network that the cluster belongs to.
                                                        health enum Health
                                                        Aggregated cluster health.
                                                        • HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN).
                                                        • ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE).
                                                        • DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD).
                                                        • DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
                                                          status enum Status
                                                          Current state of the cluster.
                                                          • STATUS_UNKNOWN: Cluster state is unknown.
                                                          • CREATING: Cluster is being created.
                                                          • RUNNING: Cluster is running normally.
                                                          • ERROR: Cluster encountered a problem and cannot operate.
                                                          • UPDATING: Cluster is being updated.
                                                          • STOPPING: Cluster is stopping.
                                                          • STOPPED: Cluster stopped.
                                                          • STARTING: Cluster is starting.

                                                            AddZookeeper

                                                            Adds a ZooKeeper subcluster to the specified ClickHouse cluster.

                                                            rpc AddZookeeper (AddClusterZookeeperRequest) returns (operation.Operation)

                                                            Metadata and response of Operation:
                                                                Operation.metadata:AddClusterZookeeperMetadata
                                                                Operation.response:Cluster

                                                            AddClusterZookeeperRequest

                                                            Field Description
                                                            cluster_id string
                                                            Required. ID of the ClickHouse cluster to modify. The maximum string length in characters is 50.
                                                            resources Resources
                                                            Resources allocated to Zookeeper hosts.
                                                            host_specs[] HostSpec
                                                            Configuration of ZooKeeper hosts.

                                                            Resources

                                                            Field Description
                                                            resource_preset_id string
                                                            ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation
                                                            disk_size int64
                                                            Volume of the storage available to a host, in bytes.
                                                            disk_type_id string
                                                            • network-hdd — network HDD drive,
                                                            • network-ssd — network SSD drive,
                                                            • local-ssd — local SSD storage.

                                                            HostSpec

                                                            Field Description
                                                            zone_id string
                                                            ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50.
                                                            type Host.Type
                                                            Required. Type of the host to be deployed.
                                                            subnet_id string
                                                            ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the Cluster.network_id field. The maximum string length in characters is 50.
                                                            assign_public_ip bool
                                                            • false — don't assign a public IP to the host.
                                                            • true — the host should have a public IP address.
                                                            shard_name string
                                                            Name of the shard that the host is assigned to. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

                                                            Operation

                                                            Field Description
                                                            id string
                                                            ID of the operation.
                                                            description string
                                                            Description of the operation. 0-256 characters long.
                                                            created_at google.protobuf.Timestamp
                                                            Creation timestamp.
                                                            created_by string
                                                            ID of the user or service account who initiated the operation.
                                                            modified_at google.protobuf.Timestamp
                                                            The time when the Operation resource was last modified.
                                                            done bool
                                                            If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
                                                            metadata google.protobuf.Any<AddClusterZookeeperMetadata>
                                                            Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
                                                            result oneof: error or response
                                                            The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
                                                              error google.rpc.Status
                                                            The error result of the operation in case of failure or cancellation.
                                                              response google.protobuf.Any<Cluster>
                                                            if operation finished successfully.

                                                            AddClusterZookeeperMetadata

                                                            Field Description
                                                            cluster_id string
                                                            ID of the ClickHouse cluster.

                                                            Cluster

                                                            Field Description
                                                            id string
                                                            ID of the ClickHouse cluster. This ID is assigned by MDB at creation time.
                                                            folder_id string
                                                            ID of the folder that the ClickHouse cluster belongs to.
                                                            created_at google.protobuf.Timestamp
                                                            Creation timestamp in RFC3339 text format.
                                                            name string
                                                            Name of the ClickHouse cluster. The name is unique within the folder. 1-63 characters long.
                                                            description string
                                                            Description of the ClickHouse cluster. 0-256 characters long.
                                                            labels map<string,string>
                                                            Custom labels for the ClickHouse cluster as key:value pairs. Maximum 64 per resource.
                                                            environment enum Environment
                                                            Deployment environment of the ClickHouse cluster.
                                                            • PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.
                                                            • PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
                                                              monitoring[] Monitoring
                                                              Description of monitoring systems relevant to the ClickHouse cluster.
                                                              config ClusterConfig
                                                              Configuration of the ClickHouse cluster.
                                                              network_id string
                                                              ID of the network that the cluster belongs to.
                                                              health enum Health
                                                              Aggregated cluster health.
                                                              • HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN).
                                                              • ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE).
                                                              • DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD).
                                                              • DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
                                                                status enum Status
                                                                Current state of the cluster.
                                                                • STATUS_UNKNOWN: Cluster state is unknown.
                                                                • CREATING: Cluster is being created.
                                                                • RUNNING: Cluster is running normally.
                                                                • ERROR: Cluster encountered a problem and cannot operate.
                                                                • UPDATING: Cluster is being updated.
                                                                • STOPPING: Cluster is stopping.
                                                                • STOPPED: Cluster stopped.
                                                                • STARTING: Cluster is starting.

                                                                  Backup

                                                                  Creates a backup for the specified ClickHouse cluster.

                                                                  rpc Backup (BackupClusterRequest) returns (operation.Operation)

                                                                  Metadata and response of Operation:
                                                                      Operation.metadata:BackupClusterMetadata
                                                                      Operation.response:Cluster

                                                                  BackupClusterRequest

                                                                  Field Description
                                                                  cluster_id string
                                                                  Required. ID of the ClickHouse cluster to back up. To get the ClickHouse cluster ID use a ClusterService.List request. The maximum string length in characters is 50.

                                                                  Operation

                                                                  Field Description
                                                                  id string
                                                                  ID of the operation.
                                                                  description string
                                                                  Description of the operation. 0-256 characters long.
                                                                  created_at google.protobuf.Timestamp
                                                                  Creation timestamp.
                                                                  created_by string
                                                                  ID of the user or service account who initiated the operation.
                                                                  modified_at google.protobuf.Timestamp
                                                                  The time when the Operation resource was last modified.
                                                                  done bool
                                                                  If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
                                                                  metadata google.protobuf.Any<BackupClusterMetadata>
                                                                  Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
                                                                  result oneof: error or response
                                                                  The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
                                                                    error google.rpc.Status
                                                                  The error result of the operation in case of failure or cancellation.
                                                                    response google.protobuf.Any<Cluster>
                                                                  if operation finished successfully.

                                                                  BackupClusterMetadata

                                                                  Field Description
                                                                  cluster_id string
                                                                  ID of the ClickHouse cluster that is being backed up.

                                                                  Cluster

                                                                  Field Description
                                                                  id string
                                                                  ID of the ClickHouse cluster. This ID is assigned by MDB at creation time.
                                                                  folder_id string
                                                                  ID of the folder that the ClickHouse cluster belongs to.
                                                                  created_at google.protobuf.Timestamp
                                                                  Creation timestamp in RFC3339 text format.
                                                                  name string
                                                                  Name of the ClickHouse cluster. The name is unique within the folder. 1-63 characters long.
                                                                  description string
                                                                  Description of the ClickHouse cluster. 0-256 characters long.
                                                                  labels map<string,string>
                                                                  Custom labels for the ClickHouse cluster as key:value pairs. Maximum 64 per resource.
                                                                  environment enum Environment
                                                                  Deployment environment of the ClickHouse cluster.
                                                                  • PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.
                                                                  • PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
                                                                    monitoring[] Monitoring
                                                                    Description of monitoring systems relevant to the ClickHouse cluster.
                                                                    config ClusterConfig
                                                                    Configuration of the ClickHouse cluster.
                                                                    network_id string
                                                                    ID of the network that the cluster belongs to.
                                                                    health enum Health
                                                                    Aggregated cluster health.
                                                                    • HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN).
                                                                    • ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE).
                                                                    • DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD).
                                                                    • DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
                                                                      status enum Status
                                                                      Current state of the cluster.
                                                                      • STATUS_UNKNOWN: Cluster state is unknown.
                                                                      • CREATING: Cluster is being created.
                                                                      • RUNNING: Cluster is running normally.
                                                                      • ERROR: Cluster encountered a problem and cannot operate.
                                                                      • UPDATING: Cluster is being updated.
                                                                      • STOPPING: Cluster is stopping.
                                                                      • STOPPED: Cluster stopped.
                                                                      • STARTING: Cluster is starting.

                                                                        Restore

                                                                        Creates a new ClickHouse cluster using the specified backup.

                                                                        rpc Restore (RestoreClusterRequest) returns (operation.Operation)

                                                                        Metadata and response of Operation:
                                                                            Operation.metadata:RestoreClusterMetadata
                                                                            Operation.response:Cluster

                                                                        RestoreClusterRequest

                                                                        Field Description
                                                                        backup_id string
                                                                        Required. ID of the backup to create a cluster from. To get the backup ID, use a ClusterService.ListBackups request.
                                                                        name string
                                                                        Required. Name of the new ClickHouse cluster. The name must be unique within the folder. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
                                                                        description string
                                                                        Description of the new ClickHouse cluster. The maximum string length in characters is 256.
                                                                        labels map<string,string>
                                                                        Custom labels for the ClickHouse cluster as key:value pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary". No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The maximum string length in characters for each key is 63. Each key must match the regular expression [a-z][-_0-9a-z]*.
                                                                        environment Cluster.Environment
                                                                        Required. Deployment environment of the new ClickHouse cluster.
                                                                        config_spec ConfigSpec
                                                                        Required. Configuration for the ClickHouse cluster to be created.
                                                                        host_specs[] HostSpec
                                                                        Configurations for ClickHouse hosts that should be created for the cluster that is being created from the backup. The number of elements must be greater than 0.
                                                                        network_id string
                                                                        Required. ID of the network to create the ClickHouse cluster in. The maximum string length in characters is 50.
                                                                        folder_id string
                                                                        ID of the folder to create the ClickHouse cluster in. The maximum string length in characters is 50.

                                                                        ConfigSpec

                                                                        Field Description
                                                                        version string
                                                                        Version of the ClickHouse server software.
                                                                        clickhouse Clickhouse
                                                                        Configuration and resources for a ClickHouse server.
                                                                        zookeeper Zookeeper
                                                                        Configuration and resources for a ZooKeeper server.
                                                                        backup_window_start google.type.TimeOfDay
                                                                        Time to start the daily backup, in the UTC timezone.
                                                                        access Access
                                                                        Access policy to DB

                                                                        Clickhouse

                                                                        Field Description
                                                                        config config.ClickhouseConfig
                                                                        Configuration for a ClickHouse server.
                                                                        resources Resources
                                                                        Resources allocated to ClickHouse hosts.

                                                                        Zookeeper

                                                                        Field Description
                                                                        resources Resources
                                                                        Resources allocated to ZooKeeper hosts. If not set, minimal available resources will be used. All available resource presets can be retrieved with a ResourcePresetService.List request.

                                                                        Access

                                                                        Field Description
                                                                        data_lens bool
                                                                        Allow access for DataLens
                                                                        web_sql bool
                                                                        Allow access for Web SQL

                                                                        HostSpec

                                                                        Field Description
                                                                        zone_id string
                                                                        ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50.
                                                                        type Host.Type
                                                                        Required. Type of the host to be deployed.
                                                                        subnet_id string
                                                                        ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the Cluster.network_id field. The maximum string length in characters is 50.
                                                                        assign_public_ip bool
                                                                        • false — don't assign a public IP to the host.
                                                                        • true — the host should have a public IP address.
                                                                        shard_name string
                                                                        Name of the shard that the host is assigned to. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

                                                                        Operation

                                                                        Field Description
                                                                        id string
                                                                        ID of the operation.
                                                                        description string
                                                                        Description of the operation. 0-256 characters long.
                                                                        created_at google.protobuf.Timestamp
                                                                        Creation timestamp.
                                                                        created_by string
                                                                        ID of the user or service account who initiated the operation.
                                                                        modified_at google.protobuf.Timestamp
                                                                        The time when the Operation resource was last modified.
                                                                        done bool
                                                                        If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
                                                                        metadata google.protobuf.Any<RestoreClusterMetadata>
                                                                        Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
                                                                        result oneof: error or response
                                                                        The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
                                                                          error google.rpc.Status
                                                                        The error result of the operation in case of failure or cancellation.
                                                                          response google.protobuf.Any<Cluster>
                                                                        if operation finished successfully.

                                                                        RestoreClusterMetadata

                                                                        Field Description
                                                                        cluster_id string
                                                                        ID of the new ClickHouse cluster that is being created from a backup.
                                                                        backup_id string
                                                                        ID of the backup that is being used for creating a cluster.

                                                                        Cluster

                                                                        Field Description
                                                                        id string
                                                                        ID of the ClickHouse cluster. This ID is assigned by MDB at creation time.
                                                                        folder_id string
                                                                        ID of the folder that the ClickHouse cluster belongs to.
                                                                        created_at google.protobuf.Timestamp
                                                                        Creation timestamp in RFC3339 text format.
                                                                        name string
                                                                        Name of the ClickHouse cluster. The name is unique within the folder. 1-63 characters long.
                                                                        description string
                                                                        Description of the ClickHouse cluster. 0-256 characters long.
                                                                        labels map<string,string>
                                                                        Custom labels for the ClickHouse cluster as key:value pairs. Maximum 64 per resource.
                                                                        environment enum Environment
                                                                        Deployment environment of the ClickHouse cluster.
                                                                        • PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.
                                                                        • PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
                                                                          monitoring[] Monitoring
                                                                          Description of monitoring systems relevant to the ClickHouse cluster.
                                                                          config ClusterConfig
                                                                          Configuration of the ClickHouse cluster.
                                                                          network_id string
                                                                          ID of the network that the cluster belongs to.
                                                                          health enum Health
                                                                          Aggregated cluster health.
                                                                          • HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN).
                                                                          • ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE).
                                                                          • DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD).
                                                                          • DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
                                                                            status enum Status
                                                                            Current state of the cluster.
                                                                            • STATUS_UNKNOWN: Cluster state is unknown.
                                                                            • CREATING: Cluster is being created.
                                                                            • RUNNING: Cluster is running normally.
                                                                            • ERROR: Cluster encountered a problem and cannot operate.
                                                                            • UPDATING: Cluster is being updated.
                                                                            • STOPPING: Cluster is stopping.
                                                                            • STOPPED: Cluster stopped.
                                                                            • STARTING: Cluster is starting.

                                                                              ListLogs

                                                                              Retrieves logs for the specified ClickHouse cluster.

                                                                              rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)

                                                                              ListClusterLogsRequest

                                                                              Field Description
                                                                              cluster_id string
                                                                              Required. ID of the ClickHouse cluster to request logs for. To get the ClickHouse cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
                                                                              column_filter[] string
                                                                              Columns from logs table to request. If no columns are specified, entire log records are returned.
                                                                              service_type enum ServiceType
                                                                              Type of the service to request logs about.
                                                                              • CLICKHOUSE: Logs of ClickHouse activity.
                                                                                from_time google.protobuf.Timestamp
                                                                                Start timestamp for the logs request, in RFC3339 text format.
                                                                                to_time google.protobuf.Timestamp
                                                                                End timestamp for the logs request, in RFC3339 text format.
                                                                                page_size int64
                                                                                The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClusterLogsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
                                                                                page_token string
                                                                                Page token. To get the next page of results, set page_token to the ListClusterLogsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

                                                                                ListClusterLogsResponse

                                                                                Field Description
                                                                                logs[] LogRecord
                                                                                Requested log records.
                                                                                next_page_token string
                                                                                This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterLogsRequest.page_size, use the next_page_token as the value for the ListClusterLogsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

                                                                                LogRecord

                                                                                Field Description
                                                                                timestamp google.protobuf.Timestamp
                                                                                Log record timestamp in RFC3339 text format.
                                                                                message map<string,string>
                                                                                Contents of the log record.

                                                                                ListOperations

                                                                                Retrieves the list of Operation resources for the specified cluster.

                                                                                rpc ListOperations (ListClusterOperationsRequest) returns (ListClusterOperationsResponse)

                                                                                ListClusterOperationsRequest

                                                                                Field Description
                                                                                cluster_id string
                                                                                Required. ID of the ClickHouse Cluster resource to list operations for. The maximum string length in characters is 50.
                                                                                page_size int64
                                                                                The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClusterOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
                                                                                page_token string
                                                                                Page token. To get the next page of results, set page_token to the ListClusterOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

                                                                                ListClusterOperationsResponse

                                                                                Field Description
                                                                                operations[] operation.Operation
                                                                                List of Operation resources for the specified ClickHouse cluster.
                                                                                next_page_token string
                                                                                This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterOperationsRequest.page_size, use the next_page_token as the value for the ListClusterOperationsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

                                                                                Operation

                                                                                Field Description
                                                                                id string
                                                                                ID of the operation.
                                                                                description string
                                                                                Description of the operation. 0-256 characters long.
                                                                                created_at google.protobuf.Timestamp
                                                                                Creation timestamp.
                                                                                created_by string
                                                                                ID of the user or service account who initiated the operation.
                                                                                modified_at google.protobuf.Timestamp
                                                                                The time when the Operation resource was last modified.
                                                                                done bool
                                                                                If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
                                                                                metadata google.protobuf.Any
                                                                                Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
                                                                                result oneof: error or response
                                                                                The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
                                                                                  error google.rpc.Status
                                                                                The error result of the operation in case of failure or cancellation.
                                                                                  response google.protobuf.Any
                                                                                The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

                                                                                ListBackups

                                                                                Retrieves the list of available backups for the specified ClickHouse cluster.

                                                                                rpc ListBackups (ListClusterBackupsRequest) returns (ListClusterBackupsResponse)

                                                                                ListClusterBackupsRequest

                                                                                Field Description
                                                                                cluster_id string
                                                                                Required. ID of the ClickHouse cluster. To get the ClickHouse cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
                                                                                page_size int64
                                                                                The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClusterBackupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
                                                                                page_token string
                                                                                Page token. To get the next page of results, set page_token to the ListClusterBackupsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

                                                                                ListClusterBackupsResponse

                                                                                Field Description
                                                                                backups[] Backup
                                                                                List of ClickHouse Backup resources.
                                                                                next_page_token string
                                                                                This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterBackupsRequest.page_size, use the next_page_token as the value for the ListClusterBackupsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

                                                                                Backup

                                                                                Field Description
                                                                                id string
                                                                                ID of the backup.
                                                                                folder_id string
                                                                                ID of the folder that the backup belongs to.
                                                                                created_at google.protobuf.Timestamp
                                                                                Creation timestamp in RFC3339 text format (i.e. when the backup operation was completed).
                                                                                source_cluster_id string
                                                                                ID of the ClickHouse cluster that the backup was created for.
                                                                                source_shard_names[] string
                                                                                Names of the shards included in the backup.
                                                                                started_at google.protobuf.Timestamp
                                                                                Time when the backup operation was started.

                                                                                ListHosts

                                                                                Retrieves a list of hosts for the specified cluster.

                                                                                rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)

                                                                                ListClusterHostsRequest

                                                                                Field Description
                                                                                cluster_id string
                                                                                Required. ID of the ClickHouse cluster. To get the ClickHouse cluster ID use a ClusterService.List request. The maximum string length in characters is 50.
                                                                                page_size int64
                                                                                The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClusterHostsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
                                                                                page_token string
                                                                                Page token. To get the next page of results, set page_token to the ListClusterHostsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

                                                                                ListClusterHostsResponse

                                                                                Field Description
                                                                                hosts[] Host
                                                                                Requested list of hosts for the cluster.
                                                                                next_page_token string
                                                                                This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterHostsRequest.page_size, use the next_page_token as the value for the ListClusterHostsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

                                                                                Host

                                                                                Field Description
                                                                                name string
                                                                                Name of the ClickHouse host. The host name is assigned by MDB at creation time, and cannot be changed. 1-63 characters long.
                                                                                The name is unique across all existing MDB hosts in Yandex.Cloud, as it defines the FQDN of the host.
                                                                                cluster_id string
                                                                                ID of the ClickHouse host. The ID is assigned by MDB at creation time.
                                                                                zone_id string
                                                                                ID of the availability zone where the ClickHouse host resides.
                                                                                type enum Type
                                                                                Type of the host.
                                                                                • CLICKHOUSE: ClickHouse host.
                                                                                • ZOOKEEPER: ZooKeeper host.
                                                                                  resources Resources
                                                                                  Resources allocated to the ClickHouse host.
                                                                                  health enum Health
                                                                                  Status code of the aggregated health of the host.
                                                                                  • UNKNOWN: Health of the host is unknown.
                                                                                  • ALIVE: The host is performing all its functions normally.
                                                                                  • DEAD: The host is inoperable, and cannot perform any of its essential functions.
                                                                                  • DEGRADED: The host is degraded, and can perform only some of its essential functions.
                                                                                    services[] Service
                                                                                    Services provided by the host.
                                                                                    subnet_id string
                                                                                    ID of the subnet that the host belongs to.
                                                                                    assign_public_ip bool
                                                                                    Flag showing public IP assignment status to this host.
                                                                                    shard_name string

                                                                                    Resources

                                                                                    Field Description
                                                                                    resource_preset_id string
                                                                                    ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation
                                                                                    disk_size int64
                                                                                    Volume of the storage available to a host, in bytes.
                                                                                    disk_type_id string
                                                                                    • network-hdd — network HDD drive,
                                                                                    • network-ssd — network SSD drive,
                                                                                    • local-ssd — local SSD storage.

                                                                                    Service

                                                                                    Field Description
                                                                                    type enum Type
                                                                                    Type of the service provided by the host.
                                                                                    • CLICKHOUSE: The host is a ClickHouse server.
                                                                                    • ZOOKEEPER: The host is a ZooKeeper server.
                                                                                      health enum Health
                                                                                      Status code of server availability.
                                                                                      • UNKNOWN: Health of the server is unknown.
                                                                                      • ALIVE: The server is working normally.
                                                                                      • DEAD: The server is dead or unresponsive.

                                                                                        AddHosts

                                                                                        Creates new hosts for a cluster.

                                                                                        rpc AddHosts (AddClusterHostsRequest) returns (operation.Operation)

                                                                                        Metadata and response of Operation:
                                                                                            Operation.metadata:AddClusterHostsMetadata
                                                                                            Operation.response:google.protobuf.Empty

                                                                                        AddClusterHostsRequest

                                                                                        Field Description
                                                                                        cluster_id string
                                                                                        Required. ID of the ClickHouse cluster to add hosts to. To get the ClickHouse cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
                                                                                        host_specs[] HostSpec
                                                                                        Configurations for ClickHouse hosts that should be added to the cluster. The number of elements must be greater than 0.

                                                                                        HostSpec

                                                                                        Field Description
                                                                                        zone_id string
                                                                                        ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50.
                                                                                        type Host.Type
                                                                                        Required. Type of the host to be deployed.
                                                                                        subnet_id string
                                                                                        ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the Cluster.network_id field. The maximum string length in characters is 50.
                                                                                        assign_public_ip bool
                                                                                        • false — don't assign a public IP to the host.
                                                                                        • true — the host should have a public IP address.
                                                                                        shard_name string
                                                                                        Name of the shard that the host is assigned to. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

                                                                                        Operation

                                                                                        Field Description
                                                                                        id string
                                                                                        ID of the operation.
                                                                                        description string
                                                                                        Description of the operation. 0-256 characters long.
                                                                                        created_at google.protobuf.Timestamp
                                                                                        Creation timestamp.
                                                                                        created_by string
                                                                                        ID of the user or service account who initiated the operation.
                                                                                        modified_at google.protobuf.Timestamp
                                                                                        The time when the Operation resource was last modified.
                                                                                        done bool
                                                                                        If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
                                                                                        metadata google.protobuf.Any<AddClusterHostsMetadata>
                                                                                        Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
                                                                                        result oneof: error or response
                                                                                        The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
                                                                                          error google.rpc.Status
                                                                                        The error result of the operation in case of failure or cancellation.
                                                                                          response google.protobuf.Any<google.protobuf.Empty>
                                                                                        if operation finished successfully.

                                                                                        AddClusterHostsMetadata

                                                                                        Field Description
                                                                                        cluster_id string
                                                                                        ID of the ClickHouse cluster to which the hosts are being added.
                                                                                        host_names[] string
                                                                                        Names of hosts that are being added to the cluster.

                                                                                        DeleteHosts

                                                                                        Deletes the specified hosts for a cluster.

                                                                                        rpc DeleteHosts (DeleteClusterHostsRequest) returns (operation.Operation)

                                                                                        Metadata and response of Operation:
                                                                                            Operation.metadata:DeleteClusterHostsMetadata
                                                                                            Operation.response:google.protobuf.Empty

                                                                                        DeleteClusterHostsRequest

                                                                                        Field Description
                                                                                        cluster_id string
                                                                                        Required. ID of the ClickHouse cluster to remove hosts from. To get the ClickHouse cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
                                                                                        host_names[] string
                                                                                        Names of hosts to delete. The number of elements must be greater than 0. The maximum string length in characters for each value is 253.

                                                                                        Operation

                                                                                        Field Description
                                                                                        id string
                                                                                        ID of the operation.
                                                                                        description string
                                                                                        Description of the operation. 0-256 characters long.
                                                                                        created_at google.protobuf.Timestamp
                                                                                        Creation timestamp.
                                                                                        created_by string
                                                                                        ID of the user or service account who initiated the operation.
                                                                                        modified_at google.protobuf.Timestamp
                                                                                        The time when the Operation resource was last modified.
                                                                                        done bool
                                                                                        If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
                                                                                        metadata google.protobuf.Any<DeleteClusterHostsMetadata>
                                                                                        Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
                                                                                        result oneof: error or response
                                                                                        The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
                                                                                          error google.rpc.Status
                                                                                        The error result of the operation in case of failure or cancellation.
                                                                                          response google.protobuf.Any<google.protobuf.Empty>
                                                                                        if operation finished successfully.

                                                                                        DeleteClusterHostsMetadata

                                                                                        Field Description
                                                                                        cluster_id string
                                                                                        ID of the ClickHouse cluster to remove hosts from.
                                                                                        host_names[] string
                                                                                        Names of hosts that are being deleted.

                                                                                        GetShard

                                                                                        Returns the specified shard.

                                                                                        rpc GetShard (GetClusterShardRequest) returns (Shard)

                                                                                        GetClusterShardRequest

                                                                                        Field Description
                                                                                        cluster_id string
                                                                                        Required. ID of the cluster that the shard belongs to. To get the cluster ID, use a ClusterService.List(#List) request. To get the name of the database, use a [ClusterService.List] request. The maximum string length in characters is 50.
                                                                                        shard_name string
                                                                                        Required. Name of the shard to request information about. To get the name of a shard, use a ClusterService.ListShards request. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

                                                                                        Shard

                                                                                        Field Description
                                                                                        name string
                                                                                        Name of the shard.
                                                                                        cluster_id string
                                                                                        ID of the cluster that the shard belongs to.
                                                                                        config ShardConfig
                                                                                        Configuration of the shard.

                                                                                        ShardConfig

                                                                                        Field Description
                                                                                        clickhouse Clickhouse
                                                                                        ClickHouse configuration for a shard.

                                                                                        Clickhouse

                                                                                        Field Description
                                                                                        config config.ClickhouseConfigSet
                                                                                        ClickHouse settings for a shard.
                                                                                        resources Resources
                                                                                        Computational resources for a shard.
                                                                                        weight google.protobuf.Int64Value
                                                                                        Relative weight of a shard considered when writing data to the cluster. For details, see ClickHouse documentation.

                                                                                        ListShards

                                                                                        Retrieves a list of shards that belong to the specified cluster.

                                                                                        rpc ListShards (ListClusterShardsRequest) returns (ListClusterShardsResponse)

                                                                                        ListClusterShardsRequest

                                                                                        Field Description
                                                                                        cluster_id string
                                                                                        Required. ID of the ClickHouse cluster to list shards in. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
                                                                                        page_size int64
                                                                                        The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClusterShardsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
                                                                                        page_token string
                                                                                        Page token. to get the next page of results, set page_token to the ListClusterShardsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

                                                                                        ListClusterShardsResponse

                                                                                        Field Description
                                                                                        shards[] Shard
                                                                                        List of ClickHouse shards.
                                                                                        next_page_token string
                                                                                        This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterShardsRequest.page_size, use the next_page_token as the value for the ListClusterShardsRequest.page_token parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

                                                                                        Shard

                                                                                        Field Description
                                                                                        name string
                                                                                        Name of the shard.
                                                                                        cluster_id string
                                                                                        ID of the cluster that the shard belongs to.
                                                                                        config ShardConfig
                                                                                        Configuration of the shard.

                                                                                        ShardConfig

                                                                                        Field Description
                                                                                        clickhouse Clickhouse
                                                                                        ClickHouse configuration for a shard.

                                                                                        Clickhouse

                                                                                        Field Description
                                                                                        config config.ClickhouseConfigSet
                                                                                        ClickHouse settings for a shard.
                                                                                        resources Resources
                                                                                        Computational resources for a shard.
                                                                                        weight google.protobuf.Int64Value
                                                                                        Relative weight of a shard considered when writing data to the cluster. For details, see ClickHouse documentation.

                                                                                        AddShard

                                                                                        Creates a new shard in the specified cluster.

                                                                                        rpc AddShard (AddClusterShardRequest) returns (operation.Operation)

                                                                                        Metadata and response of Operation:
                                                                                            Operation.metadata:AddClusterShardMetadata
                                                                                            Operation.response:Shard

                                                                                        AddClusterShardRequest

                                                                                        Field Description
                                                                                        cluster_id string
                                                                                        Required. ID of the ClickHouse cluster to add a shard to. To get the ClickHouse cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
                                                                                        shard_name string
                                                                                        Required. Name for the new shard. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
                                                                                        config_spec ShardConfigSpec
                                                                                        Configuration of the new shard.
                                                                                        host_specs[] HostSpec
                                                                                        Configurations for ClickHouse hosts that should be created with the shard. The number of elements must be greater than 0.

                                                                                        ShardConfigSpec

                                                                                        Field Description
                                                                                        clickhouse Clickhouse
                                                                                        ClickHouse configuration for a shard.

                                                                                        Clickhouse

                                                                                        Field Description
                                                                                        config config.ClickhouseConfig
                                                                                        ClickHouse settings for the shard.
                                                                                        resources Resources
                                                                                        Computational resources for the shard.
                                                                                        weight google.protobuf.Int64Value
                                                                                        Relative weight of the shard considered when writing data to the cluster. For details, see ClickHouse documentation.

                                                                                        HostSpec

                                                                                        Field Description
                                                                                        zone_id string
                                                                                        ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50.
                                                                                        type Host.Type
                                                                                        Required. Type of the host to be deployed.
                                                                                        subnet_id string
                                                                                        ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the Cluster.network_id field. The maximum string length in characters is 50.
                                                                                        assign_public_ip bool
                                                                                        • false — don't assign a public IP to the host.
                                                                                        • true — the host should have a public IP address.
                                                                                        shard_name string
                                                                                        Name of the shard that the host is assigned to. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

                                                                                        Operation

                                                                                        Field Description
                                                                                        id string
                                                                                        ID of the operation.
                                                                                        description string
                                                                                        Description of the operation. 0-256 characters long.
                                                                                        created_at google.protobuf.Timestamp
                                                                                        Creation timestamp.
                                                                                        created_by string
                                                                                        ID of the user or service account who initiated the operation.
                                                                                        modified_at google.protobuf.Timestamp
                                                                                        The time when the Operation resource was last modified.
                                                                                        done bool
                                                                                        If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
                                                                                        metadata google.protobuf.Any<AddClusterShardMetadata>
                                                                                        Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
                                                                                        result oneof: error or response
                                                                                        The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
                                                                                          error google.rpc.Status
                                                                                        The error result of the operation in case of failure or cancellation.
                                                                                          response google.protobuf.Any<Shard>
                                                                                        if operation finished successfully.

                                                                                        AddClusterShardMetadata

                                                                                        Field Description
                                                                                        cluster_id string
                                                                                        ID of the cluster that a shard is being added to.
                                                                                        shard_name string
                                                                                        Name of the shard being created.

                                                                                        Shard

                                                                                        Field Description
                                                                                        name string
                                                                                        Name of the shard.
                                                                                        cluster_id string
                                                                                        ID of the cluster that the shard belongs to.
                                                                                        config ShardConfig
                                                                                        Configuration of the shard.

                                                                                        UpdateShard

                                                                                        Modifies the specified shard.

                                                                                        rpc UpdateShard (UpdateClusterShardRequest) returns (operation.Operation)

                                                                                        Metadata and response of Operation:
                                                                                            Operation.metadata:UpdateClusterShardMetadata
                                                                                            Operation.response:Shard

                                                                                        UpdateClusterShardRequest

                                                                                        Field Description
                                                                                        cluster_id string
                                                                                        Required. ID of the ClickHouse cluster the shard belongs to. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
                                                                                        shard_name string
                                                                                        Required. Name of the shard to be updated. To get the name of a shard, use a ClusterService.ListShards request. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
                                                                                        update_mask google.protobuf.FieldMask
                                                                                        Field mask that specifies which attributes of the ClickHouse shard should be updated.
                                                                                        config_spec ShardConfigSpec
                                                                                        New configuration for the specified shard.

                                                                                        ShardConfigSpec

                                                                                        Field Description
                                                                                        clickhouse Clickhouse
                                                                                        ClickHouse configuration for a shard.

                                                                                        Clickhouse

                                                                                        Field Description
                                                                                        config config.ClickhouseConfig
                                                                                        ClickHouse settings for the shard.
                                                                                        resources Resources
                                                                                        Computational resources for the shard.
                                                                                        weight google.protobuf.Int64Value
                                                                                        Relative weight of the shard considered when writing data to the cluster. For details, see ClickHouse documentation.

                                                                                        Operation

                                                                                        Field Description
                                                                                        id string
                                                                                        ID of the operation.
                                                                                        description string
                                                                                        Description of the operation. 0-256 characters long.
                                                                                        created_at google.protobuf.Timestamp
                                                                                        Creation timestamp.
                                                                                        created_by string
                                                                                        ID of the user or service account who initiated the operation.
                                                                                        modified_at google.protobuf.Timestamp
                                                                                        The time when the Operation resource was last modified.
                                                                                        done bool
                                                                                        If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
                                                                                        metadata google.protobuf.Any<UpdateClusterShardMetadata>
                                                                                        Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
                                                                                        result oneof: error or response
                                                                                        The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
                                                                                          error google.rpc.Status
                                                                                        The error result of the operation in case of failure or cancellation.
                                                                                          response google.protobuf.Any<Shard>
                                                                                        if operation finished successfully.

                                                                                        UpdateClusterShardMetadata

                                                                                        Field Description
                                                                                        cluster_id string
                                                                                        ID of the cluster that contains the shard being updated.
                                                                                        shard_name string
                                                                                        Name of the shard being updated.

                                                                                        Shard

                                                                                        Field Description
                                                                                        name string
                                                                                        Name of the shard.
                                                                                        cluster_id string
                                                                                        ID of the cluster that the shard belongs to.
                                                                                        config ShardConfig
                                                                                        Configuration of the shard.

                                                                                        DeleteShard

                                                                                        Deletes the specified shard.

                                                                                        rpc DeleteShard (DeleteClusterShardRequest) returns (operation.Operation)

                                                                                        Metadata and response of Operation:
                                                                                            Operation.metadata:DeleteClusterShardMetadata
                                                                                            Operation.response:google.protobuf.Empty

                                                                                        DeleteClusterShardRequest

                                                                                        Field Description
                                                                                        cluster_id string
                                                                                        Required. ID of the ClickHouse cluster the shard belongs to. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
                                                                                        shard_name string
                                                                                        Required. Name of the shard to be deleted. To get the name of a shard, use a ClusterService.ListShards request. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

                                                                                        Operation

                                                                                        Field Description
                                                                                        id string
                                                                                        ID of the operation.
                                                                                        description string
                                                                                        Description of the operation. 0-256 characters long.
                                                                                        created_at google.protobuf.Timestamp
                                                                                        Creation timestamp.
                                                                                        created_by string
                                                                                        ID of the user or service account who initiated the operation.
                                                                                        modified_at google.protobuf.Timestamp
                                                                                        The time when the Operation resource was last modified.
                                                                                        done bool
                                                                                        If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
                                                                                        metadata google.protobuf.Any<DeleteClusterShardMetadata>
                                                                                        Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
                                                                                        result oneof: error or response
                                                                                        The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
                                                                                          error google.rpc.Status
                                                                                        The error result of the operation in case of failure or cancellation.
                                                                                          response google.protobuf.Any<google.protobuf.Empty>
                                                                                        if operation finished successfully.

                                                                                        DeleteClusterShardMetadata

                                                                                        Field Description
                                                                                        cluster_id string
                                                                                        ID of the cluster that contains the shard being deleted.
                                                                                        shard_name string
                                                                                        Name of the shard being deleted.

                                                                                        CreateExternalDictionary

                                                                                        Creates an external dictionary for the specified ClickHouse cluster.

                                                                                        rpc CreateExternalDictionary (CreateClusterExternalDictionaryRequest) returns (operation.Operation)

                                                                                        Metadata and response of Operation:
                                                                                            Operation.metadata:CreateClusterExternalDictionaryMetadata
                                                                                            Operation.response:Cluster

                                                                                        CreateClusterExternalDictionaryRequest

                                                                                        Field Description
                                                                                        cluster_id string
                                                                                        Required. ID of the ClickHouse cluster to create the external dictionary for. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
                                                                                        external_dictionary config.ClickhouseConfig.ExternalDictionary
                                                                                        Configuration of the external dictionary.

                                                                                        Operation

                                                                                        Field Description
                                                                                        id string
                                                                                        ID of the operation.
                                                                                        description string
                                                                                        Description of the operation. 0-256 characters long.
                                                                                        created_at google.protobuf.Timestamp
                                                                                        Creation timestamp.
                                                                                        created_by string
                                                                                        ID of the user or service account who initiated the operation.
                                                                                        modified_at google.protobuf.Timestamp
                                                                                        The time when the Operation resource was last modified.
                                                                                        done bool
                                                                                        If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
                                                                                        metadata google.protobuf.Any<CreateClusterExternalDictionaryMetadata>
                                                                                        Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
                                                                                        result oneof: error or response
                                                                                        The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
                                                                                          error google.rpc.Status
                                                                                        The error result of the operation in case of failure or cancellation.
                                                                                          response google.protobuf.Any<Cluster>
                                                                                        if operation finished successfully.

                                                                                        CreateClusterExternalDictionaryMetadata

                                                                                        Field Description
                                                                                        cluster_id string
                                                                                        ID of the cluster for which an external dictionary is being created.

                                                                                        Cluster

                                                                                        Field Description
                                                                                        id string
                                                                                        ID of the ClickHouse cluster. This ID is assigned by MDB at creation time.
                                                                                        folder_id string
                                                                                        ID of the folder that the ClickHouse cluster belongs to.
                                                                                        created_at google.protobuf.Timestamp
                                                                                        Creation timestamp in RFC3339 text format.
                                                                                        name string
                                                                                        Name of the ClickHouse cluster. The name is unique within the folder. 1-63 characters long.
                                                                                        description string
                                                                                        Description of the ClickHouse cluster. 0-256 characters long.
                                                                                        labels map<string,string>
                                                                                        Custom labels for the ClickHouse cluster as key:value pairs. Maximum 64 per resource.
                                                                                        environment enum Environment
                                                                                        Deployment environment of the ClickHouse cluster.
                                                                                        • PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.
                                                                                        • PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
                                                                                          monitoring[] Monitoring
                                                                                          Description of monitoring systems relevant to the ClickHouse cluster.
                                                                                          config ClusterConfig
                                                                                          Configuration of the ClickHouse cluster.
                                                                                          network_id string
                                                                                          ID of the network that the cluster belongs to.
                                                                                          health enum Health
                                                                                          Aggregated cluster health.
                                                                                          • HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN).
                                                                                          • ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE).
                                                                                          • DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD).
                                                                                          • DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
                                                                                            status enum Status
                                                                                            Current state of the cluster.
                                                                                            • STATUS_UNKNOWN: Cluster state is unknown.
                                                                                            • CREATING: Cluster is being created.
                                                                                            • RUNNING: Cluster is running normally.
                                                                                            • ERROR: Cluster encountered a problem and cannot operate.
                                                                                            • UPDATING: Cluster is being updated.
                                                                                            • STOPPING: Cluster is stopping.
                                                                                            • STOPPED: Cluster stopped.
                                                                                            • STARTING: Cluster is starting.

                                                                                              DeleteExternalDictionary

                                                                                              Deletes the specified external dictionary.

                                                                                              rpc DeleteExternalDictionary (DeleteClusterExternalDictionaryRequest) returns (operation.Operation)

                                                                                              Metadata and response of Operation:
                                                                                                  Operation.metadata:DeleteClusterExternalDictionaryMetadata
                                                                                                  Operation.response:Cluster

                                                                                              DeleteClusterExternalDictionaryRequest

                                                                                              Field Description
                                                                                              cluster_id string
                                                                                              Required. ID of the ClickHouse cluster to delete the external dictionary from. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
                                                                                              external_dictionary_name string
                                                                                              Name of the external dictionary to delete.

                                                                                              Operation

                                                                                              Field Description
                                                                                              id string
                                                                                              ID of the operation.
                                                                                              description string
                                                                                              Description of the operation. 0-256 characters long.
                                                                                              created_at google.protobuf.Timestamp
                                                                                              Creation timestamp.
                                                                                              created_by string
                                                                                              ID of the user or service account who initiated the operation.
                                                                                              modified_at google.protobuf.Timestamp
                                                                                              The time when the Operation resource was last modified.
                                                                                              done bool
                                                                                              If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
                                                                                              metadata google.protobuf.Any<DeleteClusterExternalDictionaryMetadata>
                                                                                              Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
                                                                                              result oneof: error or response
                                                                                              The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
                                                                                                error google.rpc.Status
                                                                                              The error result of the operation in case of failure or cancellation.
                                                                                                response google.protobuf.Any<Cluster>
                                                                                              if operation finished successfully.

                                                                                              DeleteClusterExternalDictionaryMetadata

                                                                                              Field Description
                                                                                              cluster_id string
                                                                                              ID of the cluster where an external dictionary is being deleted.

                                                                                              Cluster

                                                                                              Field Description
                                                                                              id string
                                                                                              ID of the ClickHouse cluster. This ID is assigned by MDB at creation time.
                                                                                              folder_id string
                                                                                              ID of the folder that the ClickHouse cluster belongs to.
                                                                                              created_at google.protobuf.Timestamp
                                                                                              Creation timestamp in RFC3339 text format.
                                                                                              name string
                                                                                              Name of the ClickHouse cluster. The name is unique within the folder. 1-63 characters long.
                                                                                              description string
                                                                                              Description of the ClickHouse cluster. 0-256 characters long.
                                                                                              labels map<string,string>
                                                                                              Custom labels for the ClickHouse cluster as key:value pairs. Maximum 64 per resource.
                                                                                              environment enum Environment
                                                                                              Deployment environment of the ClickHouse cluster.
                                                                                              • PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.
                                                                                              • PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
                                                                                                monitoring[] Monitoring
                                                                                                Description of monitoring systems relevant to the ClickHouse cluster.
                                                                                                config ClusterConfig
                                                                                                Configuration of the ClickHouse cluster.
                                                                                                network_id string
                                                                                                ID of the network that the cluster belongs to.
                                                                                                health enum Health
                                                                                                Aggregated cluster health.
                                                                                                • HEALTH_UNKNOWN: State of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN).
                                                                                                • ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE).
                                                                                                • DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD).
                                                                                                • DEGRADED: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE).
                                                                                                  status enum Status
                                                                                                  Current state of the cluster.
                                                                                                  • STATUS_UNKNOWN: Cluster state is unknown.
                                                                                                  • CREATING: Cluster is being created.
                                                                                                  • RUNNING: Cluster is running normally.
                                                                                                  • ERROR: Cluster encountered a problem and cannot operate.
                                                                                                  • UPDATING: Cluster is being updated.
                                                                                                  • STOPPING: Cluster is stopping.
                                                                                                  • STOPPED: Cluster stopped.
                                                                                                  • STARTING: Cluster is starting.