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
{
"clusterId": "string",
"pageSize": "int64",
"pageToken": "string"
}
|
Field |
Description |
|
clusterId |
string Required field. ID of the OpenSearch cluster. To get the ID, use a ClusterService.List request. |
|
pageSize |
int64 The maximum number of results per page to return. If the number of available |
|
pageToken |
string Page token. To get the next page of results, set |
ListClusterBackupsResponse
{
"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[] |
List of the OpenSearch cluster backups. |
|
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClustersRequest.pageSize, use the Each subsequent list 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. |