Method listBackups
Retrieves a list of backups for a cluster.
To list all backups in a folder, make a list request.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-mysql/v1/clusters/{clusterId}/backups
Path parameters
| Parameter | Description |
|---|---|
| clusterId | Required. ID of the cluster to list backups for. To get this ID, make a list request. The maximum string length in characters is 50. |
Query parameters
| Parameter | Description |
|---|---|
| pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the API returns a nextPageToken that can be used to get the next page of results in the subsequent listBackups requests. The maximum value is 1000. |
| pageToken | Page token that can be used to iterate through multiple pages of results. To get the next page of results, set pageToken to the nextPageToken returned by the previous listBackups request. The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"backups": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"sourceClusterId": "string",
"startedAt": "string"
}
],
"nextPageToken": "string"
}
| Field | Description |
|---|---|
| backups[] | object An object that represents MySQL backup. See the documentation for details. |
| backups[]. id |
string Required. ID of the backup. |
| backups[]. folderId |
string ID of the folder that the backup belongs to. |
| backups[]. createdAt |
string (date-time) Creation timestamp (the time when the backup operation was completed). String in RFC3339 text format. |
| backups[]. sourceClusterId |
string ID of the cluster that the backup was created for. |
| backups[]. startedAt |
string (date-time) Start timestamp (the time when the backup operation was started). String in RFC3339 text format. |
| nextPageToken | string The token that can be used to get the next page of results. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken in the subsequent listBackups request to iterate through multiple pages of results. Each of the subsequent listBackups requests should use the nextPageToken value returned by the previous request to continue paging through the results. |