ListShards

Retrieves a list of shards.

TypeScript

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

const ListClusterShardsRequest =
  cloudApi.mdb.clickhouse_cluster_service.ListClusterShardsRequest;

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

  const result = await client.listShards(
    ListClusterShardsRequest.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 ListClusterShardsRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

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

ListClusterShardsRequest

clusterId : string

ID of the Redis cluster to list shards in. To get the cluster ID use 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 ListClusterShardsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100.

pageToken : string

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

ListClusterShardsResponse

shards : Shard

List of Redis shards.

nextPageToken : string

This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterShardsRequest.page_size, use the next_page_token as the value for the ListClusterShardsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Shard

name : string

Name of the Redis shard. The shard name is assigned by user at creation time, and cannot be changed. 1-63 characters long.

clusterId : string

ID of the Redis cluster the shard belongs to. The ID is assigned by MDB at creation time.

---