Contact UsGet started

Managed Service for Elasticsearch API, REST: Cluster.ListBackups

Written by
Updated at October 17, 2024

Returns the list of available backups for the specified Elasticsearch cluster.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-elasticsearch/v1/clusters/{clusterId}/backups

Path parameters

Field

Description

clusterId

string

Required field. Required. ID of the Elasticsearch cluster.

Query parameters

Field

Description

pageSize

string (int64)

The maximum number of results per page that should be returned. If the number of available
results is larger than page_size, the service returns a next_page_token that can be used
to get the next page of results in subsequent ListClusterBackups requests.
Acceptable values are 0 to 1000, inclusive. Default value: 100.

pageToken

string

Page token. Set page_token to the next_page_token returned by a previous ListClusterBackups
request to get the next page of results.

Response

HTTP Code: 200 - OK

{
  "backups": [
    {
      "id": "string",
      "folderId": "string",
      "sourceClusterId": "string",
      "startedAt": "string",
      "createdAt": "string",
      "indices": [
        "string"
      ],
      "elasticsearchVersion": "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 ListClusterBackups requests,
if the number of results is larger than page_size specified in the request.
To get the next page, specify the value of next_page_token as a value for
the page_token parameter in the next ListClusterBackups request. Subsequent ListClusterBackups
requests will have their own next_page_token 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 associated Elasticsearch cluster.

startedAt

string (date-time)

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

The time when the backup was created (i.e. when the backup operation 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

Indices names. (max 100)

elasticsearchVersion

string

Elasticsearch version used to create the snapshot

sizeBytes

string (int64)

Total size of all indices in backup. in bytes

indicesTotal

string (int64)

Total count of indices in backup
Previous
Backup
Next
Restore