Managed Service for ClickHouse API, gRPC: ClusterService.ListShardGroups
Retrieves a list of shard groups that belong to specified cluster.
gRPC request
rpc ListShardGroups (ListClusterShardGroupsRequest) returns (ListClusterShardGroupsResponse)
ListClusterShardGroupsRequest
{
"cluster_id": "string",
"page_size": "int64",
"page_token": "string"
}
|
Field |
Description |
|
cluster_id |
string Required field. ID of the cluster that the shard group belongs to. The maximum string length in characters is 50. |
|
page_size |
int64 The maximum number of results per page to return. Acceptable values are 0 to 1000, inclusive. |
|
page_token |
string Page token. The maximum string length in characters is 100. |
ListClusterShardGroupsResponse
{
"shard_groups": [
{
"name": "string",
"cluster_id": "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"
}
]
}
]
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
shard_groups[] |
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. |
ShardGroup
|
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[] |
List of external shards contained in the shard group. |
ExternalShard
|
Field |
Description |
|
name |
string Name of the external shard. |
|
weight |
Relative weight of the external shard considered when writing data to the cluster. For details, see ClickHouse documentation. |
|
replicas[] |
List of replicas contained in the external shard. |
Replica
|
Field |
Description |
|
host |
string Name (FQDN) or IP address of the external replica host. |
|
port |
Port to connect to the external replica. If not specified, the default ClickHouse port is used. |
|
secure |
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 |
Priority of the external replica for load balancing. |