Sign in
Clusters (ksqldbcm/v2)

Read a Cluster

General Availability

Make a request to read a cluster.

get/ksqldbcm/v2/clusters/{id}

Path parameters

idstring required

The unique identifier for the cluster.

Query parameters

environmentstring required

Filter a collection by a string search

Scope the operation to the given environment.

Response

Cluster.

api_version'ksqldbcm/v2' required

APIVersion defines the schema version of this representation of a resource.

kind'Cluster' required

Kind defines the object this REST resource represents.

idstring required

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/ksqldbcm/v2/clusters/lksqlc-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lksqlc-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "spec": {
    "display_name": "ksqlDB_cluster_0",
    "csu": 4,
    "kafka_cluster": {
      "id": "lkc-00000",
      "related": "https://api.confluent.cloud/cmk/v2/clusters/lkc-00000",
      "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-00000"
    },
    "credential_identity": {
      "id": "u-a83k9b",
      "related": "https://api.confluent.cloud/iam/v2/users/u-a83k9b",
      "resource_name": "https://api.confluent.cloud/user=u-a83k9b"
    },
    "environment": {
      "id": "env-00000",
      "related": "https://api.confluent.cloud/org/v2/environments/env-00000",
      "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
    }
  },
  "status": {
    "http_endpoint": "https://pksqlc-00000.us-central1.gcp.glb.confluent.cloud",
    "phase": "PROVISIONING",
    "storage": 125,
    "topic_prefix": "pksqlc-00000"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.