Managed Service for OpenSearch API, REST: Backup.List
Returns the list of available backups for the specified OpenSearch cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-opensearch/v1/backups
Query parameters
|
Field |
Description |
|
folderId |
string Required field. ID of the folder to list backups in. |
|
pageSize |
string (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 |
Response
HTTP Code: 200 - OK
{
"backups": [
{
"id": "string",
"folderId": "string",
"sourceClusterId": "string",
"startedAt": "string",
"createdAt": "string",
"indices": [
"string"
],
"opensearchVersion": "string",
"sizeBytes": "string",
"indicesTotal": "string",
"incrementalSizeBytes": "string",
"totalSizeBytes": "string",
"freeSpaceRequiredBytes": "string"
}
],
"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 |
string (date-time) Time when the backup operation was started. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
createdAt |
string (date-time) Time when the backup operation was completed. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
indices[] |
string Names of indices in the backup. |
|
opensearchVersion |
string OpenSearch version used to create the backup. |
|
sizeBytes |
string (int64) Size of the backup in bytes. |
|
indicesTotal |
string (int64) The number of indices in the backup. |
|
incrementalSizeBytes |
string (int64) Size of files which were copied as part of the incremental snapshot. |
|
totalSizeBytes |
string (int64) Size of files that are referenced by the snapshot. |
|
freeSpaceRequiredBytes |
string (int64) The space amount required to restore from this backup. |