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
{
"clusterId": "string",
"pageSize": "int64",
"pageToken": "string"
}
|
Field |
Description |
|
clusterId |
string Required field. ID of the cluster that the shard group belongs to. To get the cluster ID, make a ClusterService.List request. |
|
pageSize |
int64 The maximum number of results per page to return. If the number of available results is larger than |
|
pageToken |
string Page token. To get the next page of results, set |
ListClusterShardGroupsResponse
{
"shardGroups": [
{
"name": "string",
"clusterId": "string",
"description": "string",
"shardNames": [
"string"
]
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
shardGroups[] |
List of ClickHouse cluster's shard groups. |
|
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterShardGroupsRequest.pageSize, use the |
ShardGroup
|
Field |
Description |
|
name |
string Name of the shard group. |
|
clusterId |
string ID of the ClickHouse cluster that the shard group belongs to. |
|
description |
string Description of the shard group. 0-256 characters long. |
|
shardNames[] |
string List of shard names contained in the shard group. |