ListBackups

Returns a list of available backups for the specified OpenSearch cluster.

TypeScript

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

const ListClusterBackupsRequest =
  cloudApi.mdb.clickhouse_cluster_service.ListClusterBackupsRequest;

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

  const result = await client.listBackups(
    ListClusterBackupsRequest.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 ListClusterBackupsRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

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

ListClusterBackupsRequest

clusterId : string

ID of the OpenSearch cluster.

To get the 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 ListClusterBackupsResponse.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 ListClusterBackupsResponse.next_page_token returned by the previous list request.

ListClusterBackupsResponse

backups : Backup

List of the OpenSearch cluster backups.

nextPageToken : string

This token allows you to get the next page of results for list requests.

If the number of results is larger than ListClustersRequest.page_size, use the next_page_token as the value for the ListClustersRequest.page_token parameter in the next list request.

Each subsequent list request has its own next_page_token to continue paging through the results.

Backup

id : string

Required. ID of the backup.

folderId : string

ID of the folder that the backup belongs to.

sourceClusterId : string

ID of the OpenSearch cluster that the backup was created for.

startedAt : google.protobuf.Timestamp

Time when the backup operation was started.

createdAt : google.protobuf.Timestamp

Time when the backup operation was completed.

indices : string

Names of indices in the backup.

opensearchVersion : string

OpenSearch version used to create the backup.

sizeBytes : int64

Size of the backup in bytes.

indicesTotal : int64

The number of indices in the backup.

---