Managed Service for ClickHouse API, REST: Backup methods
A set of methods for managing ClickHouse Backup resources.
JSON Representation
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"sourceClusterId": "string",
"sourceShardNames": [
"string"
],
"startedAt": "string",
"size": "string",
"type": "string"
}
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 (i.e. when the backup operation was completed). 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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
size | string (int64) Size of backup in bytes. |
type | string How this backup was created (manual/automatic/etc...).
|
Methods
Method | Description |
---|---|
delete | Deletes the specified ClickHouse Backup. |
get | Returns the specified ClickHouse Backup resource. |
list | Retrieves the list of Backup resources available for the specified folder. |