Managed Service for OpenSearch API, REST: Backup.Get
Returns the specified backup of an OpenSearch cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-opensearch/v1/backups/{backupId}
Path parameters
|
Field |
Description |
|
backupId |
string Required field. ID of the backup to return. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"sourceClusterId": "string",
"startedAt": "string",
"createdAt": "string",
"indices": [
"string"
],
"opensearchVersion": "string",
"sizeBytes": "string",
"indicesTotal": "string",
"incrementalSizeBytes": "string",
"totalSizeBytes": "string",
"freeSpaceRequiredBytes": "string"
}
|
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. |