Managed Service for MySQL API, REST: Backup.list
Retrieves the list of backups in a folder.
To list backups for an existing cluster, make a listBackups request.
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 this ID, make 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 API returns a nextPageToken that can be used to get the next page of results in the subsequent list 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 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",
"size": "string",
"type": "string",
"status": "string"
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
backups[] | object List of backups. |
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. 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[]. 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. 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[]. size |
string (int64) Size of backup, in bytes |
backups[]. type |
string How this backup was created (manual/automatic/etc...)
|
backups[]. status |
string Status of backup
|
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 list request to iterate through multiple pages of results. Each of the subsequent list requests should use the nextPageToken value returned by the previous request to continue paging through the results. The maximum string length in characters is 100. |