1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-10 19:31:55 +00:00
gcloud-help/gcloud/alpha/container/backup-restore/backups/list
2024-07-31 09:35:16 +00:00

113 lines
4.7 KiB
Text

NAME
gcloud alpha container backup-restore backups list - list backups
SYNOPSIS
gcloud alpha container backup-restore backups list
[--backup-plan=BACKUP_PLAN --location=LOCATION] [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List Backup for GKE backups.
EXAMPLES
To list all backups in project my-project in location us-central1 under
backup plan my-backup-plan, run:
$ gcloud alpha container backup-restore backups list \
--backup-plan=my-backup-plan --project=my-project \
--location=us-central1
To list all backups in project my-project across all locations under all
backup plans, run:
$ gcloud alpha container backup-restore backups list \
--project=my-project
FLAGS
Backup plan resource - Name of the backup plan from which to list backups
(provided via options or through properties), e.g. --project=<project>
--location=<location> --backup-plan=<backupPlan>. 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-plan on the command line with a fully
specified name;
◆ set the property gkebackup/backup_plan with a fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
--backup-plan=BACKUP_PLAN
ID of the backup plan or fully qualified identifier for the backup
plan.
To set the backup-plan attribute:
▸ provide the argument --backup-plan on the command line;
▸ set the property gkebackup/backup_plan.
--location=LOCATION
Google Cloud location.
To set the location attribute:
▸ provide the argument --backup-plan on the command line with a
fully specified name;
▸ set the property gkebackup/backup_plan with a fully specified
name;
▸ provide the argument --location on the command line;
▸ set the property gkebackup/location.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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 gkebackup/v1 API. The full documentation for this 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 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. This variant is also available:
$ gcloud beta container backup-restore backups list