gcloud spanner backups describe

NAME
gcloud spanner backups describe - retrieves information about a backup
SYNOPSIS
gcloud spanner backups describe(BACKUP :--instance=INSTANCE)[GCLOUD_WIDE_FLAG …]
DESCRIPTION
Retrieves information about a backup.
EXAMPLES
To describe a backup, run:
gcloudspannerbackupsdescribeBACKUP_ID--instance=INSTANCE_NAME
POSITIONAL ARGUMENTS
Backup resource - Cloud Spanner backup to describe. The arguments in this groupcan be used to specify the attributes of this resource. (NOTE) Some attributesare not given arguments in this group but can be set in other ways.

To set theproject attribute:

  • provide the argumentbackup on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

BACKUP
ID of the backup or fully qualified identifier for the backup.

To set thebackup attribute:

  • provide the argumentbackup on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--instance=INSTANCE
The name of the Cloud Spanner instance.To set theinstance attribute:
  • provide the argumentbackup on the command line with a fullyspecified name;
  • provide the argument--instance on the command line;
  • set the propertyspanner/instance.
GCLOUD WIDE FLAGS
These flags are available to all commands:--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.

Run$gcloud help for details.

API REFERENCE
This command uses thespanner/v1 API. The full documentation forthis API can be found at:https://cloud.google.com/spanner/
NOTES
These variants are also available:
gcloudalphaspannerbackupsdescribe
gcloudbetaspannerbackupsdescribe

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-05-07 UTC.