gcloud managed-kafka consumer-groups list Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud managed-kafka consumer-groups list - list all Managed Service for Apache Kafka consumer groups in a given cluster and location
- SYNOPSIS
gcloud managed-kafka consumer-groups list(CLUSTER:--location=LOCATION)[--filter=EXPRESSION][--limit=LIMIT][--page-size=PAGE_SIZE][--sort-by=[FIELD,…]][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- List all Managed Service for Apache Kafka consumer groups in a given cluster andlocation. To specify the maximum number of consumer groups to list, use the--limit flag.
- EXAMPLES
- To list all consumer groups in a cluster named mycluster located in us-central1,run the following:
gcloudmanaged-kafkaconsumer-groupslistmycluster--location=us-central1 - POSITIONAL ARGUMENTS
- Cluster resource - Identifies the cluster which contains all the consumer groupsto be listed. The arguments in this group can be used to specify the attributesof this resource. (NOTE) Some attributes are not given arguments in this groupbut can be set in other ways.
To set the
projectattribute:- provide the argument
clusteron the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
CLUSTER- ID of the cluster or fully qualified identifier for the cluster.
To set the
clusterattribute:- provide the argument
clusteron the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--location=LOCATION- ID of the location of the Managed Service for Apache Kafka resource. Seehttps://cloud.google.com/managed-service-for-apache-kafka/docs/locationsfor a list of supported locations.To set the
locationattribute:- provide the argument
clusteron the command line with a fullyspecified name; - provide the argument
--locationon the command line.
- provide the argument
- provide the argument
- Cluster resource - Identifies the cluster which contains all the consumer groupsto be listed. The arguments in this group can be used to specify the attributesof this resource. (NOTE) Some attributes are not given arguments in this groupbut can be set in other ways.
- LIST COMMAND FLAGS
--filter=EXPRESSION- Apply a Boolean filter
EXPRESSIONto each resource itemto be listed. If the expression evaluatesTrue, then that item islisted. For more details and examples of filter expressions, run $gcloud topic filters. This flaginteracts 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. Thisflag 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 themaximum number of resources per page. The default is determined by the serviceif it supports paging, otherwise it is
unlimited(no paging).Paging may be applied before or after--filterand--limitdepending on the service. --sort-by=[FIELD,…]- Comma-separated list of resource field key names to sort by. The default orderis ascending. Prefix a field with ``~´´ for descending order on thatfield. This flag interacts with other flags that are applied in this order:
--flatten,--sort-by,--filter,--limit.
- 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 helpfor details. - API REFERENCE
- This command uses the
managedkafka/v1API. The full documentationfor this API can be found at:https://cloud.google.com/managed-service-for-apache-kafka/docs - NOTES
- These variants are also available:
gcloudalphamanaged-kafkaconsumer-groupslistgcloudbetamanaged-kafkaconsumer-groupslist
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.