BackupService
Статья создана
A set of methods for managing ClickHouse Backup resources.
| Call | Description |
|---|---|
| Get | Returns the specified ClickHouse Backup resource. |
| List | Retrieves the list of Backup resources available for the specified folder. |
Calls BackupService
Get
Returns the specified ClickHouse Backup resource.
To get the list of available ClickHouse Backup resources, make a List request.
rpc Get (GetBackupRequest) returns (Backup)
GetBackupRequest
| Field | Description |
|---|---|
| backup_id | string Required. ID of the backup to return information about. To get the backup ID, use a ClusterService.ListBackups request. |
Backup
| Field | Description |
|---|---|
| id | string ID of the backup. |
| folder_id | string ID of the folder that the backup belongs to. |
| created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 text format (i.e. when the backup operation was completed). |
| source_cluster_id | string ID of the ClickHouse cluster that the backup was created for. |
| source_shard_names[] | string Names of the shards included in the backup. |
| started_at | google.protobuf.Timestamp Time when the backup operation was started. |
List
Retrieves the list of Backup resources available for the specified folder.
rpc List (ListBackupsRequest) returns (ListBackupsResponse)
ListBackupsRequest
| Field | Description |
|---|---|
| folder_id | string Required. ID of the folder to list backups in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50. |
| page_size | 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 ListBackupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
| page_token | string Page token. To get the next page of results, set page_token to the ListBackupsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
ListBackupsResponse
| Field | Description |
|---|---|
| backups[] | Backup List of Backup resources. |
| next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListBackupsRequest.page_size, use the next_page_token as the value for the ListBackupsRequest.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. |
Backup
| Field | Description |
|---|---|
| id | string ID of the backup. |
| folder_id | string ID of the folder that the backup belongs to. |
| created_at | google.protobuf.Timestamp Creation timestamp in RFC3339 text format (i.e. when the backup operation was completed). |
| source_cluster_id | string ID of the ClickHouse cluster that the backup was created for. |
| source_shard_names[] | string Names of the shards included in the backup. |
| started_at | google.protobuf.Timestamp Time when the backup operation was started. |