Contact UsGet started

Managed Service for OpenSearch API, REST: Backup.List

Written by
Updated at November 26, 2024

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 pageSize, the service returns
a ListBackupsResponse.nextPageToken that can be used to get the next page of results
in subsequent list requests.

Default value is 100.

pageToken

string

The page token. To get the next page of results, set pageToken to the ListBackupsResponse.nextPageToken
returned by the previous list request.

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[]

Backup

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,
use the nextPageToken as the value for the ListBackupsRequest.pageToken parameter in the next list request.

Each subsequent ListBackups request has its own nextPageToken to continue paging through the results.

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
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).

createdAt

string (date-time)

Time when the backup operation was completed.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).

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.
Previous
Get
Next
Overview