Managed Service for ClickHouse API, REST: Cluster.getShardGroup
Returns the specified shard group.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/{clusterId}/shardGroups/{shardGroupName}
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. |
shardGroupName | Required. Name of the shard group to request information about. To get the name of a shard group, make a listShardGroups request. The maximum string length in characters is 63. Value must match the regular expression |
Response
HTTP Code: 200 - OK
{
"name": "string",
"clusterId": "string",
"description": "string",
"shardNames": [
"string"
]
}
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. |