gcloud alpha dataproc clusters list - view a list of clusters in a project
gcloud alpha dataproc clusters list [--region=REGION] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE; default=100] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
(ALPHA) View a list of clusters in a project. An optional filter can be used to constrain the clusters returned. Filters are case-sensitive and have the following syntax:
field = value [AND [field = value]] ...
where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.
To see the list of all clusters in Dataproc's 'us-central1' region, run:
$ gcloud alpha dataproc clusters list --region='us-central1'
To show a cluster in Dataproc's 'global' region with the name 'mycluster', run:
$ gcloud alpha dataproc clusters list --region='global' \ --filter='clusterName = mycluster'
To see the list of all clusters in Dataproc's 'global' region with specified labels, run:
$ gcloud alpha dataproc clusters list --region='global' \ --filter='labels.env = staging AND labels.starred = *'
To see a list of all active clusters in Dataproc's 'europe-west1' region with specified labels, run:
$ gcloud alpha dataproc clusters list --region='europe-west1' \ --filter='status.state = ACTIVE AND labels.env = staging AND labels.starred = *'
- --region=REGION
Dataproc region to use. Each Dataproc region constitutes an independent resource namespace constrained to deploying instances into Compute Engine zones inside the region. Overrides the default dataproc/region property value for this command invocation.
- --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; default=100
Some services group resource list output into pages. This flag specifies the maximum number of resources per page. The default is 100. 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.
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.
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 dataproc clusters list
$ gcloud beta dataproc clusters list