Managed Service for OpenSearch API, gRPC: BackupService.Get
Written by
Updated at October 17, 2024
Returns the specified backup of an OpenSearch cluster.
gRPC request
rpc Get (GetBackupRequest) returns (Backup)
GetBackupRequest
{
"backupId": "string"
}
|
Field |
Description |
|
backupId |
string Required field. ID of the backup to return. |
Backup
{
"id": "string",
"folderId": "string",
"sourceClusterId": "string",
"startedAt": "google.protobuf.Timestamp",
"createdAt": "google.protobuf.Timestamp",
"indices": [
"string"
],
"opensearchVersion": "string",
"sizeBytes": "int64",
"indicesTotal": "int64"
}
|
Field |
Description |
|
id |
string Required. ID of the backup. |
|
folderId |
string ID of the folder that the backup belongs to. |
|
sourceClusterId |
string ID of the OpenSearch cluster that the backup was created for. |
|
startedAt |
Time when the backup operation was started. |
|
createdAt |
Time when the backup operation was completed. |
|
indices[] |
string Names of indices in the backup. |
|
opensearchVersion |
string OpenSearch version used to create the backup. |
|
sizeBytes |
int64 Size of the backup in bytes. |
|
indicesTotal |
int64 The number of indices in the backup. |