Managed Service for ClickHouse API, REST: Cluster.listShardGroups
Retrieves a list of shard groups that belong to specified cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/{clusterId}/shardGroups
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the cluster that the shard group belongs to. To get the cluster ID, make a list request. The maximum string length in characters is 50. |
Query parameters
Parameter | Description |
---|---|
pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive. |
pageToken | Page token. To get the next page of results, set pageToken to the nextPageToken returned by the previous list request. The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"shardGroups": [
{
"name": "string",
"clusterId": "string",
"description": "string",
"shardNames": [
"string"
]
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
shardGroups[] | object List of ClickHouse cluster's shard groups. |
shardGroups[]. name |
string Name of the shard group. |
shardGroups[]. clusterId |
string ID of the ClickHouse cluster that the shard group belongs to. |
shardGroups[]. description |
string Description of the shard group. 0-256 characters long. |
shardGroups[]. shardNames[] |
string List of shard names contained in the shard group. |
nextPageToken | string This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results. |