Managed Service for Elasticsearch API, gRPC: BackupService.List
Returns the list of available backups for the specified Elasticsearch cluster.
gRPC request
rpc List (ListBackupsRequest) returns (ListBackupsResponse)
ListBackupsRequest
{
"folder_id": "string",
"page_size": "int64",
"page_token": "string"
}
|
Field |
Description |
|
folder_id |
string Required field. Required. ID of the folder to list backups in. |
|
page_size |
int64 The maximum number of results per page that should be returned. If the number of available |
|
page_token |
string Page token. Set |
ListBackupsResponse
{
"backups": [
{
"id": "string",
"folder_id": "string",
"source_cluster_id": "string",
"started_at": "google.protobuf.Timestamp",
"created_at": "google.protobuf.Timestamp",
"indices": [
"string"
],
"elasticsearch_version": "string",
"size_bytes": "int64",
"indices_total": "int64"
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
backups[] |
Requested list of backups. |
|
next_page_token |
string This token allows you to get the next page of results for ListBackups requests, |
Backup
|
Field |
Description |
|
id |
string Required. ID of the backup. |
|
folder_id |
string ID of the folder that the backup belongs to. |
|
source_cluster_id |
string ID of the associated Elasticsearch cluster. |
|
started_at |
The time when the backup operation was started. |
|
created_at |
The time when the backup was created (i.e. when the backup operation completed). |
|
indices[] |
string Indices names. (max 100) |
|
elasticsearch_version |
string Elasticsearch version used to create the snapshot |
|
size_bytes |
int64 Total size of all indices in backup. in bytes |
|
indices_total |
int64 Total count of indices in backup |