Managed Service for ClickHouse API, gRPC: ClusterService.ListShardGroups

Field

Description

cluster_id

string

Required field. ID of the cluster that the shard group belongs to.
To get the cluster ID, make 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 ListClusterShardGroupsResponse.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 ListClusterShardGroupsResponse.next_page_token returned by the previous list request.

The maximum string length in characters is 100.

Field

Description

shard_groups[]

ShardGroup

List of ClickHouse cluster's shard groups.

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 ListClusterShardGroupsRequest.page_size, use the next_page_token as the value for the ListClusterShardGroupsRequest.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.

Field

Description

name

string

Name of the shard group.

cluster_id

string

ID of the ClickHouse cluster that the shard group belongs to.

description

string

Description of the shard group. 0-256 characters long.

shard_names[]

string

List of shard names contained in the shard group.

external_shards[]

ExternalShard

List of external shards contained in the shard group.

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.

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.