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
Parameter | Description |
---|---|
folderId | Required. ID of the folder to list backups in. The maximum string length in characters is 50. |
pageSize | The maximum number of results per page that should be returned. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Default value is 100. Acceptable values are 0 to 1000, inclusive. |
pageToken | The page token. To get the next page of results, set pageToken to the nextPageToken returned by the previous list request. The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"backups": [
{
"id": "string",
"folderId": "string",
"sourceClusterId": "string",
"startedAt": "string",
"createdAt": "string",
"indices": [
"string"
],
"opensearchVersion": "string",
"sizeBytes": "string",
"indicesTotal": "string"
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
backups[] | object Requested list of backups. |
backups[]. id |
string Required. ID of the backup. |
backups[]. folderId |
string ID of the folder that the backup belongs to. |
backups[]. sourceClusterId |
string ID of the OpenSearch cluster that the backup was created for. |
backups[]. 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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
backups[]. 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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
backups[]. indices[] |
string Names of indices in the backup. The maximum number of elements is 100. |
backups[]. opensearchVersion |
string OpenSearch version used to create the backup. |
backups[]. sizeBytes |
string (int64) Size of the backup in bytes. |
backups[]. indicesTotal |
string (int64) The number of indices in the backup. |
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 pageSize specified in the request, use the nextPageToken as the value for the pageToken parameter in the next list request. Each subsequent ListBackups request has its own nextPageToken to continue paging through the results. |