View Kafka clusters

You can view a list of clusters or details for a single cluster using the Confluent Cloud Console, Confluent CLI, and REST API.

View a list of Kafka clusters

Use this procedure to list clusters.

Cloud Console

To list clusters

From the Administration menu, select Environments.
Select an environment.
A list of clusters appears.

Confluent CLI

List clusters.

confluent kafka cluster list [flags]

For example:

confluent kafka cluster list

  Current |     ID     |        Name        |   Type   | Cloud    |  Region   | Availability | Status
----------+------------+--------------------+----------+----------+-----------+--------------+---------
          | lkc-123exc | cluster_1          | BASIC    | gcp      | us-west4  | single-zone  | UP
          | lkc-123exb | cluster_0          | STANDARD | gcp      | us-west4  | single-zone  | UP
          | lkc-123exa | my_new_cluster     | BASIC    | aws      | us-west-2 | single-zone  | UP

Confluent Cloud APIs

To list clusters, make a GET request that specifies the environment.

Request

GET /cmk/v2/clusters?environment={environment_id}

Your request can include the following parameters:

Parameter	Required or Optional	Description
`environment`	Required	Specifies the identifier for the environment that contains the clusters to list.
`page_size`	Optional	Specifies an integer page size for the returned payload. Max value is 100. Default: 10.
`spec.network`	Optional	A network identifier for the clusters to list. Your query can contain multiple network identifiers.
`page_token`	Optional	Contains the opaque pagination token string.

Response

Successful calls return HTTP 200 OK and a JSON payload that contains the list of clusters for the environment.

Responses include the following information:

The cloud provider (AWS, GCP, AZURE) and region for the cluster.
The cluster status (PROVISIONED, PROVISIONING, FAILED) and kind (Basic, Standard, Enterprise, Dedicated, and Freight).
Information about the environment that contains the cluster.
Dedicated clusters only - the number of CKUs allocated to the cluster.

Basic and Standard

Example response for Basic and Standard clusters:

HTTP/1.1 200 OK
Content-Type: application/json

{
   "api_version": "cmk/v2",
   "data": [
      {
      "api_version": "cmk/v2",
      "kind": "Cluster",
      "id": "abc-f3a90de",
      "metadata": {
         "self": "https://api.confluent.cloud/v2/kafka-clusters/abc-f3a90de",
         "resource_name": "crn://confluent.cloud/kafka=abc-f3a90de",
         "created_at": "2022-04-22T20:45:26.657894Z",
         "updated_at": "2022-04-22T21:13:55.742641944Z"
      },
      "spec": {
         "display_name": "ProdKafkaCluster",
         "availability": "Low",
         "cloud": "GCP",
         "region": "us-east4",
         "config": {
               "kind": "Basic"
         },
         "kafka_bootstrap_endpoint": "abc-00000-00000.us-east4.gcp.glb.confluent.cloud:9092",
         "http_endpoint": "https://abc-00000-00000.us-east4.gcp.glb.confluent.cloud",
         "environment": {
            "id": "env-a12b34",
            "related": "https://api.confluent.cloud/v2/environments/env-a12b34",
            "resource_name": "crn://confluent.cloud/organization=1234abcd-edef-46ac-8a41-c49e44a3fd9a/environment=env-a12b34",
            "api_version": "org/v2",
            "kind": "Environment"
         }
      },
      "status": {
         "phase": "PROVISIONED"
      }
   }
   ],
   "kind": "ClusterList",
   "metadata": {
   "first": "https://api.confluent.cloud/cmk/v2/clusters",
   "total_size": 1
   }
}

Enterprise

Example response for Enterprise clusters in a private network:

HTTP/1.1 200 OK
Content-Type: application/json

{
   "api_version": "cmk/v2",
   "data": [
      {
      "api_version": "cmk/v2",
      "kind": "Cluster",
      "id": "abc-f3a90de",
      "metadata": {
         "self": "https://api.confluent.cloud/v2/kafka-clusters/abc-f3a90de",
         "resource_name": "crn://confluent.cloud/kafka=abc-f3a90de",
         "created_at": "2022-04-22T20:45:26.657894Z",
         "updated_at": "2022-04-22T21:13:55.742641944Z"
      },
      "spec": {
         "display_name": "ProdKafkaCluster",
         "availability": "High",
         "cloud": "AWS",
         "region": "us-east-1",
         "config": {
            "kind": "Enterprise"
            },
         "kafka_bootstrap_endpoint": "abc-00000-00000.us-east4.gcp.glb.confluent.cloud:9092",
         "http_endpoint": "https://abc-00000-00000.us-east4.gcp.glb.confluent.cloud",
         "environment": {
            "id": "env-a12b34",
            "related": "https://api.confluent.cloud/v2/environments/env-a12b34",
            "resource_name": "crn://confluent.cloud/organization=1234abcd-edef-46ac-8a41-c49e44a3fd9a/environment=env-a12b34",
            "api_version": "org/v2",
            "kind": "Environment"
            },
         "network": {
            "id": "n-00000",
            "environment": "env-a12b34",
            "related": "https://api.confluent.cloud/networking/v1/networks/n-00000",
            "resource_name": "crn://confluent.cloud/organization=1234abcd-edef-46ac-8a41-c49e44a3fd9a/network=n-00000",
            "api_version": "networking/v1",
            "kind": "Network"
            }
      },
      "status": {
         "phase": "PROVISIONED"
      }
   }
   ],
   "kind": "ClusterList",
   "metadata": {
   "first": "https://api.confluent.cloud/cmk/v2/clusters",
   "total_size": 1
   }
}

Dedicated

Example response on a secure public endpoint:

HTTP/1.1 200 OK
Content-Type: application/json

{
   "api_version": "cmk/v2",
   "data": [
      {
      "api_version": "cmk/v2",
      "kind": "Cluster",
      "id": "abc-f3a90de",
      "metadata": {
         "self": "https://api.confluent.cloud/v2/kafka-clusters/abc-f3a90de",
         "resource_name": "crn://confluent.cloud/kafka=abc-f3a90de",
         "created_at": "2022-04-22T20:45:26.657894Z",
         "updated_at": "2022-04-22T21:13:55.742641944Z"
      },
      "spec": {
         "display_name": "ProdKafkaCluster",
         "availability": "SINGLE_ZONE",
         "cloud": "GCP",
         "region": "us-east4",
         "config": {
               "kind": "Dedicated",
               "cku": 2
         },
         "kafka_bootstrap_endpoint": "abc-00000-00000.us-east4.gcp.glb.confluent.cloud:9092",
         "http_endpoint": "https://abc-00000-00000.us-east4.gcp.glb.confluent.cloud",
         "environment": {
            "id": "env-a12b34",
            "related": "https://api.confluent.cloud/v2/environments/env-a12b34",
            "resource_name": "crn://confluent.cloud/organization=1234abcd-edef-46ac-8a41-c49e44a3fd9a/environment=env-a12b34",
            "api_version": "org/v2",
            "kind": "Environment"
         }
      },
      "status": {
         "phase": "PROVISIONED",
         "cku": 2
      }
   }
   ],
   "kind": "ClusterList",
   "metadata": {
   "first": "https://api.confluent.cloud/cmk/v2/clusters",
   "total_size": 1
   }
}

Example response in a private network:

HTTP/1.1 200 OK
Content-Type: application/json

{
   "api_version": "cmk/v2",
   "data": [
      {
      "api_version": "cmk/v2",
      "kind": "Cluster",
      "id": "abc-f3a90de",
      "metadata": {
         "self": "https://api.confluent.cloud/v2/kafka-clusters/abc-f3a90de",
         "resource_name": "crn://confluent.cloud/kafka=abc-f3a90de",
         "created_at": "2022-04-22T20:45:26.657894Z",
         "updated_at": "2022-04-22T21:13:55.742641944Z"
      },
      "spec": {
         "display_name": "ProdKafkaCluster",
         "availability": "SINGLE_ZONE",
         "cloud": "GCP",
         "region": "us-east4",
         "config": {
            "kind": "Dedicated",
            "cku": 2
            },
         "kafka_bootstrap_endpoint": "abc-00000-00000.us-east4.gcp.glb.confluent.cloud:9092",
         "http_endpoint": "https://abc-00000-00000.us-east4.gcp.glb.confluent.cloud",
         "environment": {
            "id": "env-a12b34",
            "related": "https://api.confluent.cloud/v2/environments/env-a12b34",
            "resource_name": "crn://confluent.cloud/organization=1234abcd-edef-46ac-8a41-c49e44a3fd9a/environment=env-a12b34",
            "api_version": "org/v2",
            "kind": "Environment"
            },
         "network": {
            "id": "n-00000",
            "environment": "env-a12b34",
            "related": "https://api.confluent.cloud/networking/v1/networks/n-00000",
            "resource_name": "crn://confluent.cloud/organization=1234abcd-edef-46ac-8a41-c49e44a3fd9a/network=n-00000",
            "api_version": "networking/v1",
            "kind": "Network"
            }
      },
      "status": {
         "phase": "PROVISIONED",
         "cku": 2
      }
   }
   ],
   "kind": "ClusterList",
   "metadata": {
   "first": "https://api.confluent.cloud/cmk/v2/clusters",
   "total_size": 1
   }
}

View a Kafka cluster

Use this procedure to get details about a cluster.

For Enterprise clusters with both Private Network Interface and PrivateLink configured, you must initially assign a default endpoint. For more information, see the section, Retrieve the endpoint for clusters with dual networking types, in Use the Confluent Cloud Console with Private Networking.

Cloud Console

To view a cluster

Navigate to the clusters page for your environment.
Select Cluster Settings to see details about your cluster. To see capacity details, click Capacity.

Confluent CLI

Describe a cluster.

confluent kafka cluster describe [id] [flags]

For example:

confluent kafka cluster describe lkc-123exa

+----------------------+---------------------------------------------------------+
| Current              | true                                                    |
| ID                   | lkc-123exa                                              |
| Name                 | my_new_cluster                                          |
| Type                 | BASIC                                                   |
| Ingress Limit (MB/s) |                                                     250 |
| Egress Limit (MB/s)  |                                                     750 |
| Storage              | 5 TB                                                    |
| Cloud                | aws                                                     |
| Region               | us-west-2                                               |
| Availability         | single-zone                                             |
| Status               | UP                                                      |
| Endpoint             | SASL_SSL://pkc-exa45.us-west-2.aws.confluent.cloud:9092 |
| REST Endpoint        | https://pkc-exa45.us-west-2.aws.confluent.cloud:443     |
+----------------------+---------------------------------------------------------+

Confluent Cloud APIs

To view a cluster, make a GET request that specifies the cluster and environment.

Request (all cluster types)

GET /cmk/v2/clusters/{id}?environment={environment_id}