This page describes how to schedule and disable automatic backups, create and manage on-demand backups, and view backups for your Cloud SQL instance.
For more information about how backups work, see Overview of backups.
Creating an on-demand backup
To create an on-demand backup:
Console
- Go to the Cloud SQL Instances page in the Google Cloud Platform Console.
- Click the instance to open its Overview page.
- Click the Backups tab.
- Click Create backup.
- On the Create backup page, add a description if needed and click Create.
gcloud
Create the backup:
gcloud sql backups create --async --instance [INSTANCE_NAME]
You can provide a description of the backup using the --description
parameter.
cURL
Create the backup:
ACCESS_TOKEN="$(gcloud auth application-default print-access-token)"
curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header 'Content-Length: 0' \
-X POST \
https://www.googleapis.com/sql/v1beta4/projects/[PROJECT-ID]/instances/[INSTANCE_NAME]/backupRuns
Scheduling automated backups
To schedule automated backups for an instance:
Console
- Go to the Cloud SQL Instances page in the Google Cloud Platform Console.
- Select the instance for which you want to configure backups.
- Click Edit.
- In the Backups section, check Enable automated backups, and choose a backup window.
- Click Save.
gcloud
- Edit the instance to specify a backup start time:
gcloud sql instances patch [INSTANCE_NAME] --backup-start-time [HH:MM]
The `backup-start-time` parameter is specified in 24-hour time, in the UTC±00 time zone, and specifies the start of a 4-hour backup window. Backups can start any time during the backup window. - Confirm your changes:
gcloud sql instances describe [INSTANCE_NAME]
UnderbackupConfigurationyou should seeenabled: trueand the time that you specified.
cURL
Patch the instance to schedule automated backups:
ACCESS_TOKEN="$(gcloud auth application-default print-access-token)"
curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header 'Content-Type: application/json' \
--data '{"settings" :
{"backupConfiguration" : {"startTime": "[HH:MM]", "enabled": true}}}' \
-X PATCH \
https://www.googleapis.com/sql/v1beta4/projects/[PROJECT-ID]/instances/[INSTANCE_NAME]
You can enable binary logging at the same time by setting
binaryLogEnabled to true within the
backupConfiguration object.
Disabling automated backups
To disable automated backups for an instance:
Console
- Go to the Cloud SQL Instances page in the Google Cloud Platform Console.
- Select the instance for which you want to disable backups.
- Click Edit.
- In the Backups section, uncheck Enable daily automated backups.
- Click Save.
gcloud
Edit the instance to disable backups:
gcloud sql instances patch [INSTANCE_NAME] --no-backup
cURL
Patch the instance to disable backups:
ACCESS_TOKEN="$(gcloud auth application-default print-access-token)"
curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header 'Content-Type: application/json' \
--data '{"settings" : {"backupConfiguration" : {"enabled": false, "binaryLogEnabled": false}}}' \
-X PATCH \
https://www.googleapis.com/sql/v1beta4/projects/[PROJECT-ID]/instances/[INSTANCE_NAME]
Viewing backups
The Cloud Platform Console does not show skipped or failed backups in the backup history. To see skipped backups, use the gcloud command line tool or the API.
Console
- Go to the Cloud SQL Instances page in the Google Cloud Platform Console.
- Click the instance to open its Overview page.
- At the bottom right corner, the list of Recent backups is displayed.
gcloud
- List the backups of the instance:
gcloud sql backups list --instance [INSTANCE_NAME]
You can filter and control the results using the standard list parameters. For a complete list, see the gcloud sql backups list command reference page.
- To list the details of one backup, use the
IDfrom the output of thebackups listcommand.gcloud sql backups describe [BACKUP_ID] --instance [INSTANCE_NAME]
cURL
List the backups for the instance:
ACCESS_TOKEN="$(gcloud auth application-default print-access-token)"
curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
-X GET \
https://www.googleapis.com/sql/v1beta4/projects/[PROJECT-ID]/instances/[INSTANCE_NAME]/backupRuns
You can also use the
APIs Explorer on the BackupRuns:list page to send the REST API request.
Deleting a backup
You can delete automated and on-demand backups.
Deleting a backup might not free up as much space as the size of the backup. This is because backups are incremental, so deleting an older backup might transfer some of its contents to a more recent backup to preserve the integrity of the newer backup.Console
- Go to the Cloud SQL Instances page in the Google Cloud Platform Console.
- Click the instance to open its Overview page.
- Click the Backups tab.
The list of existing backups is displayed. - Click more actions
for the backup you want
to delete. - Select Delete.
- In the Delete backup window, type
Deleteinto the text box and click Delete.
cURL
- List the backups to obtain the ID for the backup you want to delete:
List the backups for the instance:
ACCESS_TOKEN="$(gcloud auth application-default print-access-token)" curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ -X GET \ https://www.googleapis.com/sql/v1beta4/projects/[PROJECT-ID]/instances/[INSTANCE_NAME]/backupRuns -
Delete the backup:
curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ -X DELETE \ https://www.googleapis.com/sql/v1beta4/projects/[PROJECT-ID]/instances/[INSTANCE_NAME]/backupRuns/[BACKUP_ID]
