gcloud-sql-backups-describe

Retrieve information about a backup

$ gcloud sql backups describe [backup_id] --instance=[instance_id]

gcloud sql backups describe BACKUP_ID --instance=INSTANCE

BACKUP_ID
    The integer ID of the backup to describe. This ID can be obtained from the output of gcloud sql backups list or found in the Google Cloud Console.

--instance=INSTANCE
    The name of the Cloud SQL instance for which the backup details are being requested. This is a required flag to specify the target instance.

The gcloud sql backups describe command retrieves comprehensive and detailed information about a specific backup associated with a Google Cloud SQL instance. This command is essential for administrators and developers who need to thoroughly inspect various attributes of a backup, such as its unique ID, the instance it belongs to, its exact start and end times, total size, current status (e.g., SUCCESSFUL, FAILED), the type of backup (automatic or on-demand), and the specific database version covered. It provides a complete overview, enabling users to monitor backup progress, verify successful completions, or retrieve critical details for advanced auditing, troubleshooting, and compliance purposes within their Cloud SQL environment.

Requires the cloudsql.backups.get IAM permission for the specified Cloud SQL instance.
The specified BACKUP_ID must exist and belong to the provided INSTANCE, otherwise the command will return a 'not found' error.
Network connectivity to Google Cloud APIs is necessary for the command to execute successfully.

By default, the command outputs the backup details in a human-readable table format. For programmatic use, it is highly recommended to combine it with global flags such as --format=json or --format=yaml to retrieve machine-readable output, which is invaluable for scripting, automation, and integration with other tools.

To successfully execute this command, the calling principal (user account or service account) must possess IAM roles that grant the cloudsql.backups.get permission on the specific Cloud SQL instance. Common roles that include this permission are Cloud SQL Client and Cloud SQL Viewer.

The gcloud CLI, including the Cloud SQL command group, has evolved significantly since its inception to provide robust management capabilities for Google Cloud resources. The gcloud sql backups describe command, as part of this evolution, has been a core utility for inspecting backup resources, reflecting Google Cloud's commitment to providing detailed visibility into database operations and data protection strategies across various Cloud SQL versions and configurations.

gcloud sql backups list(1), gcloud sql backups create(1), gcloud sql operations describe(1), gcloud sql instances describe(1)