gcloud alpha container backup-restore backups describe

NAME
gcloud alpha container backup-restore backups describe - describe a backup
SYNOPSIS
gcloud alpha container backup-restore backups describe(BACKUP :--backup-plan=BACKUP_PLAN--location=LOCATION)[GCLOUD_WIDE_FLAG …]
DESCRIPTION
(ALPHA) Describe a Backup for GKE backup.
EXAMPLES
To describe a backupmy-backup in projectmy-project in locationus-central1 under backup planmy-backup-plan, run:
gcloudalphacontainerbackup-restorebackupsdescribemy-backup--backup-plan=my-backup-plan--project=my-project--location=us-central1
POSITIONAL ARGUMENTS
Backup resource - Name of the backup to describe. The name may be providedeither as a relative name, e.g.projects/<project>/locations/<location>/backupPlans/<backupPlan>/backups/<backup>or as a single ID name (with the parent resources provided via options orthrough properties), e.g.BACKUP --project=<project>--location=<location> --backup-plan=<backupPlan>. Thearguments 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 inother 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.

--backup-plan=BACKUP_PLAN
Backup Plan name.

To set thebackup-plan attribute:

  • provide the argumentbackup on the command line with a fullyspecified name;
  • provide the argument--backup-plan on the command line;
  • set the propertygkebackup/backup_plan.
--location=LOCATION
Google Cloud location.

To set thelocation attribute:

  • provide the argumentbackup on the command line with a fullyspecified name;
  • provide the argument--location on the command line;
  • set the propertygkebackup/location.
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 thegkebackup/v1 API. The full documentation forthis API can be found at:https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke
NOTES
This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. This variant is also available:
gcloudbetacontainerbackup-restorebackupsdescribe

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.