ListBackups

Retrieves a list of backups for a cluster.

To list all backups in a folder, make a BackupService.List request.

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 cluster to list backups for.

To get this 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 API returns a ListClusterBackupsResponse.next_page_token that can be used to get the next page of results in the subsequent ClusterService.ListBackups requests.

pageToken : string

Page token that can be used to iterate through multiple pages of results.

To get the next page of results, set page_token to the ListClusterBackupsResponse.next_page_token returned by the previous ClusterService.ListBackups request.

ListClusterBackupsResponse

backups : Backup

List of the cluster backups.

nextPageToken : string

The token that can be used to get the next page of results.

If the number of results is larger than ListClusterBackupsRequest.page_size, use the next_page_token as the value for the ListClusterBackupsRequest.page_token in the subsequent ClusterService.ListBackups request to iterate through multiple pages of results.

Each of the subsequent ClusterService.ListBackups requests should use the next_page_token value returned by the previous request to continue paging through the results.

Backup

An object that represents MySQL backup.

See the documentation for details.

BackupCreationType

• BACKUP_CREATION_TYPE_UNSPECIFIED

• AUTOMATED

  Backup created by automated daily schedule

• MANUAL

  Backup created by user request

BackupStatus

• BACKUP_STATUS_UNSPECIFIED

• DONE

  Backup is done

• CREATING

  Backup is creating

id : string

ID of the backup.

folderId : string

ID of the folder that the backup belongs to.

createdAt : google.protobuf.Timestamp

Creation timestamp (the time when the backup operation was completed).

sourceClusterId : string

ID of the cluster that the backup was created for.

startedAt : google.protobuf.Timestamp

Start timestamp (the time when the backup operation was started).

size : int64

Size of backup, in bytes

type : BackupCreationType

How this backup was created (manual/automatic/etc...)

status : BackupStatus

Status of backup

---