Serverless Clusters

Get Serverless cluster

Get Redpanda Serverless cluster.

get/v1/serverless/clusters/{id}

Request

  • Base URL: https://api.redpanda.com
  • URL: https://api.redpanda.com/v1/serverless/clusters/{id}
  • Auth: OAuth 2 (implicit, authorization URL https://auth.prd.cloud.redpanda.com/oauth/authorize)

Path parameters

idstring required

ID of Serverless cluster.

Query parameters

read_maskstring

Response

OK

console_private_urlstring
console_urlstring
created_atstring date-time

Timestamp when the Serverless cluster was created.

idstring

ID of the Serverless cluster. ID is an output from the Create Serverless Cluster operation and cannot be set by the caller.

namestring

Unique name of the Serverless cluster.

private_link_idstring nullable
resource_group_idstring

Resource group ID of the cluster.

serverless_regionstring

Serverless region in which the cluster is placed, backed by a cloud provider region.

state'STATE_PLACING' | 'STATE_CREATING' | 'STATE_READY' | 'STATE_DELETING' | 'STATE_FAILED' | 'STATE_SUSPENDED'

State describes the state of the ServerlessCluster.

  • STATE_PLACING: Serverless cluster is in the process of being placed on a cell with sufficient resources in the data plane.
  • STATE_CREATING: Serverless cluster is in the process of having its control plane state created.
  • STATE_READY: Serverless cluster is in execution and accepting external requests.
  • STATE_DELETING: Serverless cluster is in the process of having its control plane state removed. Resources dedicated to the cluster in the data plane will be released.
  • STATE_FAILED: Serverless cluster was unable to enter the ready state from either the creating or placing states.
  • STATE_SUSPENDED: Serverless cluster is in execution but blocks all external requests.
tagsobject
updated_atstring date-time

Timestamp when the Serverless cluster was updated.

Example response

{
  "ai_gateway": {
    "v2_url": "https://d1d9risv0c3i7qbbeoc0.aigw.adp.us-east-1.mpx.prd.cloud.redpanda.com"
  },
  "name": "development-ServerlessCluster",
  "prometheus": {
    "private_url": "https://d1d9risv0c3i7qbbeoc0.metrics.us-east-1.mpx.prd.cloud.redpanda.com/public_metrics",
    "url": "https://d1d9risv0c3i7qbbeoc0.metrics.us-east-1.mpx.prd.cloud.redpanda.com/public_metrics"
  },
  "resource_group_id": "a0b40af9-0250-48ca-9417-783ed127ce42",
  "serverless_region": "us-east-1"
}

Changes

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