Managed Service for OpenSearch API, gRPC: BackupService.List
Returns the list of available backups for the specified OpenSearch cluster.
gRPC request
rpc List (ListBackupsRequest) returns (ListBackupsResponse)
ListBackupsRequest
{
"folderId": "string",
"pageSize": "int64",
"pageToken": "string"
}
|
Field |
Description |
|
folderId |
string Required field. ID of the folder to list backups in. |
|
pageSize |
int64 The maximum number of results per page that should be returned. If the number of available results is larger than Default value is 100. |
|
pageToken |
string The page token. To get the next page of results, set |
ListBackupsResponse
{
"backups": [
{
"id": "string",
"folderId": "string",
"sourceClusterId": "string",
"startedAt": "google.protobuf.Timestamp",
"createdAt": "google.protobuf.Timestamp",
"indices": [
"string"
],
"opensearchVersion": "string",
"sizeBytes": "int64",
"indicesTotal": "int64"
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
backups[] |
Requested list of backups. |
|
nextPageToken |
string This token allows you to get the next page of results for a list request. If the number of results is larger than ListBackupsRequest.pageSize specified in the request, Each subsequent ListBackups request has its own |
Backup
|
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. |