Stay organized with collectionsSave and categorize content based on your preferences.
Listing your Connect clusters lets you view the details of all your Connect
clusters in one pane, including details such as health of the clusters,
locations, uptime of the clusters, compute size, associated
Google Cloud Managed Service for Apache Kafka cluster, and labels.
To list your Connect clusters, you can use the Google Cloud console,
the gcloud CLI, the client library, or the
Managed Kafka API. You can't use the open source Apache Kafka API to
list Connect clusters.
Required roles and permissions to list your Connect clusters
This predefined role contains
the permissions required to list your Connect clusters. To see the exact permissions that are
required, expand theRequired permissionssection:
Required permissions
The following permissions are required to list your Connect clusters:
Grant the list clusters permission on the specified location:managedkafka.connectClusters.list
Grant the get cluster details permission on the specified location:managedkafka.connectClusters.get
At the bottom of the Google Cloud console, aCloud Shellsession starts and displays a command-line prompt. Cloud Shell is a shell environment
with the Google Cloud CLI
already installed and with values already set for
your current project. It can take a few seconds for the session to initialize.
LOCATION: Required. The location of the Connect clusters
you want to list.
EXPRESSION: (Optional) A boolean filter expression to apply
to the list. If the expression evaluates toTrue, the item is included in
the list. For more details and examples, rungcloud topic filters.
LIMIT: (Optional) The maximum number of Connect clusters to
display. If not specified, all Connect clusters are listed.
PAGE_SIZE: (Optional) The number of results to display per page.
If not specified, the service determines a suitable page size.
SORT_BY: (Optional) A comma-separated list of fields to
sort by. The default sort order is ascending. To sort in descending order,
prefix the field with~.
Example output:
NAME VCPU MEMORY_BYTES STATE NETWORK
connect-cluster-alpha 3 3221225472 ACTIVE
connect-cluster-beta 3 3221225472 ACTIVE
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# List your Connect clusters\n\n| **Preview**\n|\n|\n| This product or feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA products and features are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n\nListing your Connect clusters lets you view the details of all your Connect\nclusters in one pane, including details such as health of the clusters,\nlocations, uptime of the clusters, compute size, associated\nGoogle Cloud Managed Service for Apache Kafka cluster, and labels.\n\nTo list your Connect clusters, you can use the Google Cloud console,\nthe gcloud CLI, the client library, or the\nManaged Kafka API. You can't use the open source Apache Kafka API to\nlist Connect clusters.\n\nRequired roles and permissions to list your Connect clusters\n------------------------------------------------------------\n\n\nTo get the permissions that\nyou need to list your Connect clusters,\n\nask your administrator to grant you the\n\n\n[Managed Kafka Viewer](/iam/docs/roles-permissions/managedkafka#managedkafka.viewer) (`roles/managedkafka.viewer`)\nIAM role on your project.\n\n\nFor more information about granting roles, see [Manage access to projects, folders, and organizations](/iam/docs/granting-changing-revoking-access).\n\n\nThis predefined role contains\n\nthe permissions required to list your Connect clusters. To see the exact permissions that are\nrequired, expand the **Required permissions** section:\n\n\n#### Required permissions\n\nThe following permissions are required to list your Connect clusters:\n\n- Grant the list clusters permission on the specified location: ` ``managedkafka.connectClusters.list`\n- Grant the get cluster details permission on the specified location: ` ``managedkafka.connectClusters.get`\n\n\nYou might also be able to get\nthese permissions\nwith [custom roles](/iam/docs/creating-custom-roles) or\nother [predefined roles](/iam/docs/roles-overview#predefined).\n\nFor more information about the Managed Kafka Viewer role, see\n[Managed Service for Apache Kafka predefined roles](/managed-service-for-apache-kafka/docs/access-control#predefined-roles).\n\nView your Connect clusters\n--------------------------\n\n### Console\n\n1. In the Google Cloud console, go to the **Connect clusters** page.\n\n [Go to Connect clusters](https://console.cloud.google.com/managedkafka/connectClusters)\n2. The clusters you created in a project are listed. The page lets\n you view the following cluster properties:\n\n - **Name**: The unique identifier for your Connect cluster. You\n can use it to reference the Connect cluster in various operations.\n\n - **State** : Indicates the current operational status of the\n Connect cluster, such as **Active**.\n\n - **Location**: The geographical location where your Connect\n cluster is hosted.\n\n - **Update time**: The time the Connect cluster was last\n updated.\n\n - **vCPUs**: The number of vCPUs assigned to the Connect\n cluster.\n\n - **Memory**: The total amount of memory allocated to the\n Connect cluster.\n\n - **Primary Kafka cluster**: The Managed Service for Apache Kafka\n cluster associated with the Connect cluster.\n\n - **Labels**: Key-value pairs that you can attach to the\n Connect cluster for organization, filtering, and automation\n purposes.\n\n### gcloud\n\n1. In the Google Cloud console, activate Cloud Shell.\n\n [Activate Cloud Shell](https://console.cloud.google.com/?cloudshell=true)\n\n\n At the bottom of the Google Cloud console, a\n [Cloud Shell](/shell/docs/how-cloud-shell-works)\n session starts and displays a command-line prompt. Cloud Shell is a shell environment\n with the Google Cloud CLI\n already installed and with values already set for\n your current project. It can take a few seconds for the session to initialize.\n2. Use the [`gcloud alpha managed-kafka connect-clusters list`](/sdk/gcloud/reference/alpha/managed-kafka/connect-clusters/list) command to list Connect clusters:\n\n \u003cbr /\u003e\n\n ```bash\n gcloud alpha managed-kafka connect-clusters list \\\n --location=LOCATION\n ```\n3. To further refine the list of Connect clusters, you can use additional flags:\n\n ```bash\n gcloud alpha managed-kafka connect-clusters list \\\n --location=LOCATION \\\n [--filter=EXPRESSION] \\\n [--limit=LIMIT] \\\n [--page-size=PAGE_SIZE] \\\n [--sort-by=SORT_BY]\n ```\n\n Replace the following:\n - \u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e: Required. The location of the Connect clusters\n you want to list.\n\n - \u003cvar translate=\"no\"\u003eEXPRESSION\u003c/var\u003e: (Optional) A boolean filter expression to apply\n to the list. If the expression evaluates to `True`, the item is included in\n the list. For more details and examples, run `gcloud topic filters`.\n\n - \u003cvar translate=\"no\"\u003eLIMIT\u003c/var\u003e: (Optional) The maximum number of Connect clusters to\n display. If not specified, all Connect clusters are listed.\n\n - \u003cvar translate=\"no\"\u003ePAGE_SIZE\u003c/var\u003e: (Optional) The number of results to display per page.\n If not specified, the service determines a suitable page size.\n\n - \u003cvar translate=\"no\"\u003eSORT_BY\u003c/var\u003e: (Optional) A comma-separated list of fields to\n sort by. The default sort order is ascending. To sort in descending order,\n prefix the field with `~`.\n\n \u003cbr /\u003e\n\nExample output: \n\n```\nNAME VCPU MEMORY_BYTES STATE NETWORK\nconnect-cluster-alpha 3 3221225472 ACTIVE\nconnect-cluster-beta 3 3221225472 ACTIVE\n```\n\n\u003cbr /\u003e\n\nWhat's next?\n------------\n\n- [View a Connect clusters](/managed-service-for-apache-kafka/docs/connect-cluster/view-connect-cluster)\n\n- [Update a Connect cluster](/managed-service-for-apache-kafka/docs/connect-cluster/update-connect-cluster)\n\n- [Delete a Connect cluster](/managed-service-for-apache-kafka/docs/connect-cluster/delete-connect-cluster)\n\n- [An overview of connectors](/managed-service-for-apache-kafka/docs/connect-cluster/connectors-overview)\n\n*Apache Kafka® is a registered\ntrademark of The Apache Software Foundation or its affiliates in the United\nStates and/or other countries.*"]]
