Managed Service for ClickHouse API, gRPC: ClusterService.GetShardGroup

Written by

Updated at November 26, 2024

Returns the specified shard group.

gRPC request

{
  "cluster_id": "string",
  "shard_group_name": "string"
}

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.

shard_group_name

string

Required field. Name of the shard group to request information about.

To get the name of a shard group, make a ClusterService.ListShardGroups request.

{
  "name": "string",
  "cluster_id": "string",
  "description": "string",
  "shard_names": [
    "string"
  ]
}

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.