ListShardGroups

Retrieves a list of shard groups that belong to specified cluster.

TypeScript

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const ListClusterShardGroupsRequest =
  cloudApi.mdb.clickhouse_cluster_service.ListClusterShardGroupsRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.ClusterServiceClient);

  const result = await client.listShardGroups(
    ListClusterShardGroupsRequest.fromPartial({
      clusterId: "clusterId",
      // pageSize: 0,
      // pageToken: "pageToken"
    })
  );
  console.log(result);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.dataproc.v1.cluster_service_pb2_grpc import ClusterServiceStub
from yandex.cloud.mdb.clickhouse.v1.cluster_service_pb2 import ListClusterShardGroupsRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(ClusterServiceStub)
response = service.ListShardGroups(
    ListClusterShardGroupsRequest(
        cluster_id="clusterId",
        # page_size = 0,
        # page_token = "pageToken"
    )
)
print(response)

ListClusterShardGroupsRequest

clusterId : string

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 page_size, the service returns a ListClusterShardGroupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests.

pageToken : string

Page token.

To get the next page of results, set page_token to the ListClusterShardGroupsResponse.next_page_token returned by the previous list request.

ListClusterShardGroupsResponse

shardGroups : ShardGroup

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.page_size, use the next_page_token as the value for the ListClusterShardGroupsRequest.page_token parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

ShardGroup

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.

---