NAME

gcloud alpha spanner backups describe - retrieves information about a backup

SYNOPSIS

gcloud alpha spanner backups describe (BACKUP : --instance=INSTANCE) [GCLOUD_WIDE_FLAG ...]

DESCRIPTION

(ALPHA) Retrieves information about a backup.

EXAMPLES

To describe a backup, run:

$ gcloud alpha spanner backups describe BACKUP_ID \ --instance=INSTANCE_NAME

POSITIONAL ARGUMENTS

Backup resource - Cloud Spanner backup to describe. The arguments in this group

can be used to specify the attributes of this resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways. To set the project attribute:

provide the argument backup on the command line with a fully specified name;

set the property core/project;

provide the argument --project on the command line.

This must be specified.

BACKUP

ID of the backup or fully qualified identifier for the backup. To set the backup attribute:

  • provide the argument backup on the command line.

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

--instance=INSTANCE

The name of the Cloud Spanner instance.

To set the instance attribute:

  • provide the argument backup on the command line with a fully specified name;

  • provide the argument --instance on the command line;

  • set the property spanner/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 the spanner/v1 API. The full documentation for this API can be found at: https://cloud.google.com/spanner/

NOTES

This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist. These variants are also available:

$ gcloud spanner backups describe

$ gcloud beta spanner backups describe