Managed Service for OpenSearch API, gRPC: ClusterService.ListBackups
Returns a list of available backups for the specified OpenSearch cluster.
gRPC request
rpc ListBackups (ListClusterBackupsRequest) returns (ListClusterBackupsResponse)
ListClusterBackupsRequest
{
"cluster_id": "string",
"page_size": "int64",
"page_token": "string"
}
|
Field |
Description |
|
cluster_id |
string Required field. ID of the OpenSearch cluster. 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 Acceptable values are 0 to 1000, inclusive. |
|
page_token |
string Page token. To get the next page of results, set The maximum string length in characters is 100. |
ListClusterBackupsResponse
{
"backups": [
{
"id": "string",
"folder_id": "string",
"source_cluster_id": "string",
"started_at": "google.protobuf.Timestamp",
"created_at": "google.protobuf.Timestamp",
"indices": [
"string"
],
"opensearch_version": "string",
"size_bytes": "int64",
"indices_total": "int64",
"incremental_size_bytes": "int64",
"total_size_bytes": "int64",
"free_space_required_bytes": "int64"
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
backups[] |
List of the OpenSearch cluster backups. |
|
next_page_token |
string This token allows you to get the next page of results for list 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 OpenSearch cluster that the backup was created for. |
|
started_at |
Time when the backup operation was started. |
|
created_at |
Time when the backup operation was completed. |
|
indices[] |
string Names of indices in the backup. The maximum number of elements is 100. |
|
opensearch_version |
string OpenSearch version used to create the backup. |
|
size_bytes |
int64 Size of the backup in bytes. |
|
indices_total |
int64 The number of indices in the backup. |
|
incremental_size_bytes |
int64 Size of files which were copied as part of the incremental snapshot. |
|
total_size_bytes |
int64 Size of files that are referenced by the snapshot. |
|
free_space_required_bytes |
int64 The space amount required to restore from this backup. |