Sign in

v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB
Clusters

Get Cluster

Fetches the details of the given cluster.

In order to access this endpoint, the provided API key must have at least one of the following roles:

  • Organization Owner
  • Project Owner
  • Project Manager
  • Project Viewer
  • Database Data Reader/Writer
  • Database Data Reader

To learn more, see Organization, Project, and Database Access Overview.

get/v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}

Response

Successfully fetched the cluster based on the clusterId.

idstring uuid required

The ID of the cluster created.

appServiceIdstring uuid

The ID of the linked App Service.

namestring required

Name of the cluster (up to 256 characters).

descriptionstring required

Description of the cluster (up to 1024 characters).

configurationType'singleNode' | 'multiNode' required
  • Multi-node databases are best for deployments that require high availability. If your app requires high performance and high availability, choose the Multi-node option.
  • Single-node databases have resource limitations that make them a good choice for learning, prototyping, and non-production uses. They have limited availability.
  • Single-node databases should contain only 1 node and 1 Service Group. Adding number of nodes or service groups > 1 is not allowed for such databases.
  • By default the configurationType is multiNode.
connectionStringstring required

ConnectionString specifies the Capella database endpoint for your client connection.

currentState'draft' | 'deploying' | 'scaling' | 'upgrading' | 'rebalancing' | 'peering' | 'destroying' | 'healthy' | 'degraded' | 'turnedOff' | 'turningOff' | 'turningOn' | 'deploymentFailed' | 'scaleFailed' | 'upgradeFailed' | 'rebalanceFailed' | 'peeringFailed' | 'destroyFailed' | 'offline' | 'turningOffFailed' | 'turningOnFailed' required
cmekIdstring

The ID of the CMEK Key.

enablePrivateDNSResolutionboolean
deletionProtectionboolean required

Indicates whether deletion protection is enabled for the cluster. When enabled, the cluster cannot be deleted.

expressScaling'enabled' | 'disabled'

Current status of Express Scaling. The possible values are:

  • enabled: Express Scaling is active and fully functional
  • disabled: Express Scaling is not enabled

Example response

{
  "id": "ffffffff-aaaa-1414-eeee-000000000000",
  "appServiceId": "ffffffff-aaaa-1414-eeee-000000000000",
  "name": "Test Cluster",
  "description": "Description of the cluster",
  "configurationType": "multiNode",
  "connectionString": "couchbases://cb.irxmynm6vekhe5.cloud.couchbase.com",
  "cloudProvider": {
    "type": "aws",
    "region": "us-east-1",
    "cidr": "10.1.30.0/23"
  },
  "couchbaseServer": {
    "version": "7.1"
  },
  "serviceGroups": [
    {
      "node": {
        "compute": {
          "cpu": 4,
          "ram": 16
        },
        "disk": {
          "type": "gp3",
          "storage": 50,
          "iops": 3000
        }
      },
      "numOfNodes": 3,
      "services": [
        "data"
      ]
    }
  ],
  "availability": {
    "type": "single"
  },
  "support": {
    "plan": "basic",
    "timezone": "ET"
  },
  "currentState": "deploying",
  "audit": {
    "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
    "createdAt": "2021-09-01T12:34:56Z",
    "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
    "modifiedAt": "2021-09-01T12:34:56Z",
    "version": 1
  },
  "cmekId": "ffffffff-aaaa-1414-eeee-000000000000",
  "expressScaling": "enabled"
}