Managed Service for ClickHouse API, REST: Backup.Get
Returns the specified ClickHouse Backup resource.
To get the list of available ClickHouse Backup resources, make a List request.
HTTP request
GET https://mdb.api.yandexcloud.kz/managed-clickhouse/v1/backups/{backupId}
Path parameters
|
Field |
Description |
|
backupId |
string Required field. ID of the backup to return information about. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"sourceClusterId": "string",
"sourceShardNames": [
"string"
],
"startedAt": "string",
"size": "string",
"type": "string"
}
A ClickHouse Backup resource. See the Developer's Guide
for more information.
|
Field |
Description |
|
id |
string ID of the backup. |
|
folderId |
string ID of the folder that the backup belongs to. |
|
createdAt |
string (date-time) Creation timestamp in RFC3339 text format String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
sourceClusterId |
string ID of the ClickHouse cluster that the backup was created for. |
|
sourceShardNames[] |
string Names of the shards included in the backup. |
|
startedAt |
string (date-time) Time when the backup operation was started. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
size |
string (int64) Size of backup in bytes. |
|
type |
enum (BackupType) How this backup was created (manual/automatic/etc...).
|