Method list

Retrieves the list of MySQL backups available for the specified folder.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-mysql/v1/backups

Query parameters

Parameter Description
folderId Required. ID of the folder to list backups in. To get the folder ID, use a list request. The maximum string length in characters is 50.
pageSize The maximum number of results per page to return. 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. The maximum value is 1000.
pageToken Page token. To get the next page of results, Set pageToken to the nextPageToken returned by a previous list 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

A MySQL backup. For more information, see the documentation.

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)

String in RFC3339 text format.

backups[].
sourceClusterId
string

ID of the MySQL cluster that the backup was created for.

backups[].
startedAt
string (date-time)

Time when the backup operation was started.

String in RFC3339 text format.

nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.

The maximum string length in characters is 100.