Managed Service for OpenSearch API, gRPC: BackupService.Get
Returns the specified backup of an OpenSearch cluster.
gRPC request
rpc Get (GetBackupRequest) returns (Backup)
GetBackupRequest
{
"backup_id": "string"
}
|
Field |
Description |
|
backup_id |
string Required field. ID of the backup to return. |
Backup
{
"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"
}
|
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. |