Managed Service for Elasticsearch API, REST: Cluster.listBackups
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
| Parameter | Description |
|---|---|
| clusterId | Required. Required. ID of the Elasticsearch cluster. The maximum string length in characters is 50. |
Query parameters
| Parameter | Description |
|---|---|
| pageSize | The maximum number of results per page that should be returned. If the number of available results is larger than Acceptable values are 0 to 1000, inclusive. |
| pageToken | Page token. Set 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"
],
"elasticsearchVersion": "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 associated Elasticsearch cluster. |
| backups[]. startedAt |
string (date-time) The 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) 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 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 Indices names. (max 100) The maximum number of elements is 100. |
| backups[]. elasticsearchVersion |
string Elasticsearch version used to create the snapshot |
| backups[]. sizeBytes |
string (int64) Total size of all indices in backup. in bytes |
| backups[]. indicesTotal |
string (int64) Total count of indices in backup |
| nextPageToken | string This token allows you to get the next page of results for ListClusterBackups requests, if the number of results is larger than |