Sign in
Clusters (srcm/v3)

Read a Cluster

General Availability

Make a request to read a cluster.

get/srcm/v3/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'srcm/v3' 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/srcm/v3/clusters/lsrc-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lsrc-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": "Stream Governance package",
    "package": "ESSENTIALS",
    "http_endpoint": "https://psrc-00000.us-central1.gcp.confluent.cloud",
    "catalog_http_endpoint": "https://psrc-00000.us-central1.gcp.confluent.cloud",
    "private_http_endpoint": "https://lsrc-abc.us-central-1.aws.private.confluent.cloud",
    "private_networking_config": {
      "regional_endpoints": {
        "us-central-1": "https://lsrc-abc.us-central-1.aws.private.confluent.cloud",
        "us-west-2": "https://lsrc-abc.us-west-2.aws.private.confluent.cloud"
      }
    },
    "cloud": "GCP",
    "region": "us-east4",
    "environment": {
      "id": "env-00000",
      "related": "https://api.confluent.cloud/v2/environments/env-00000",
      "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
    }
  },
  "status": {
    "phase": "PROVISIONED"
  }
}

Changes

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