Подключиться
Yandex Managed Service for ClickHouse

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.
RescheduleMaintenance Reschedules planned maintenance operation.
ListLogs Retrieves logs for the specified ClickHouse cluster.
StreamLogs Same as ListLogs but using server-side streaming.
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.
GetShardGroup Returns the specified shard group.
ListShardGroups Retrieves a list of shard groups that belong to specified cluster.
CreateShardGroup Creates a new shard group in the specified cluster.
UpdateShardGroup Updates the specified shard group.
DeleteShardGroup Deletes the specified shard group.
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.
        service_account_id string
        ID of the service account used for access to Yandex Object Storage.
        maintenance_window MaintenanceWindow
        Maintenance window for the cluster.
        planned_operation MaintenanceOperation
        Planned maintenance operation to be started for the cluster within the nearest maintenance_window.
        security_group_ids[] string
        User security groups
        deletion_protection bool
        Deletion Protection inhibits deletion of the cluster

        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 for external services.
        cloud_storage CloudStorage
        sql_database_management google.protobuf.BoolValue
        Whether database management through SQL commands is enabled.
        sql_user_management google.protobuf.BoolValue
        Whether user management through SQL commands is enabled.

        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 to export data from the cluster to Yandex DataLens.
        web_sql bool
        Allow SQL queries to the cluster databases from the Yandex.Cloud management console.
        See SQL queries in the management console for more details.
        metrika bool
        Allow to import data from Yandex.Metrica and AppMetrica to the cluster.
        See Export data to Yandex.Cloud for more details.
        serverless bool
        Allow access to cluster for Serverless.

        CloudStorage

        Field Description
        enabled bool
        Whether to use Yandex Object Storage for storing ClickHouse data.

        MaintenanceWindow

        Field Description
        policy oneof: anytime or weekly_maintenance_window
        The maintenance policy in effect.
          anytime AnytimeMaintenanceWindow
        Maintenance operation can be scheduled anytime.
          weekly_maintenance_window WeeklyMaintenanceWindow
        Maintenance operation can be scheduled on a weekly basis.

        AnytimeMaintenanceWindow

        WeeklyMaintenanceWindow

        Field Description
        day enum WeekDay
        Day of the week (in DDD format).
          hour int64
          Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive.

          MaintenanceOperation

          Field Description
          info string
          Information about this maintenance operation. The maximum string length in characters is 256.
          delayed_until google.protobuf.Timestamp
          Time until which this maintenance operation is delayed.

          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. Must 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.
                service_account_id string
                ID of the service account used for access to Yandex Object Storage.
                maintenance_window MaintenanceWindow
                Maintenance window for the cluster.
                planned_operation MaintenanceOperation
                Planned maintenance operation to be started for the cluster within the nearest maintenance_window.
                security_group_ids[] string
                User security groups
                deletion_protection bool
                Deletion Protection inhibits deletion of the cluster

                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 for external services.
                cloud_storage CloudStorage
                sql_database_management google.protobuf.BoolValue
                Whether database management through SQL commands is enabled.
                sql_user_management google.protobuf.BoolValue
                Whether user ma
                В этой статье: