Managed Service for ClickHouse API, gRPC: ClusterService.CreateShardGroup

Written by

Yandex Cloud

Updated at June 22, 2026

gRPC request
CreateClusterShardGroupRequest
ExternalShard
Replica
operation.Operation

Creates a new shard group in the specified cluster.

gRPC request

rpc CreateShardGroup (CreateClusterShardGroupRequest) returns (operation.Operation)

CreateClusterShardGroupRequest

{
  "cluster_id": "string",
  "shard_group_name": "string",
  "description": "string",
  "shard_names": [
    "string"
  ],
  "external_shards": [
    {
      "name": "string",
      "weight": "google.protobuf.Int64Value",
      "replicas": [
        {
          "host": "string",
          "port": "google.protobuf.Int64Value",
          "secure": "google.protobuf.BoolValue",
          "user": "string",
          "password": "string",
          "priority": "google.protobuf.Int64Value"
        }
      ]
    }
  ]
}

Field	Description
cluster_id	string Required field. ID of the ClickHouse cluster to add a shard group to. To get the cluster ID, make a ClusterService.List request. The maximum string length in characters is 50.
shard_group_name	string Required field. Name for the new shard group. The maximum string length in characters is 63. Value must match the regular expression `[a-zA-Z_][a-zA-Z0-9_-]*`.
description	string Description of the new shard group. 0-256 characters long.
shard_names[]	string List of shard names that should be put into the new group. To get the list, make a ClusterService.ListShardGroups request.
external_shards[]	ExternalShard List of external shards that should be put into the new group. External shards reference replicas outside this cluster.

ExternalShard

Field	Description
name	string Name of the external shard.
weight	google.protobuf.Int64Value Relative weight of the external shard considered when writing data to the cluster. For details, see ClickHouse documentation.
replicas[]	Replica List of replicas contained in the external shard.

Replica

Field	Description
host	string Name (FQDN) or IP address of the external replica host.
port	google.protobuf.Int64Value Port to connect to the external replica. If not specified, the default ClickHouse port is used.
secure	google.protobuf.BoolValue Whether to use a secure (SSL/TLS) connection when connecting to the external replica.
user	string Name of the user to authenticate with on the external replica.
password	string Password of the user to authenticate with on the external replica.
priority	google.protobuf.Int64Value Priority of the external replica for load balancing. The replica with the lowest priority value is preferred when establishing a connection.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // end of the list of possible fields
}

An Operation resource. For more information, see 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `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.
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. Includes only one of the fields `error`, `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.

Managed Service for ClickHouse API, gRPC: ClusterService.CreateShardGroup

gRPC requestgRPC request

CreateClusterShardGroupRequestCreateClusterShardGroupRequest

ExternalShardExternalShard

ReplicaReplica

operation.Operationoperation.Operation

Was the article helpful?

gRPC request

CreateClusterShardGroupRequest

ExternalShard

Replica

operation.Operation