COcouchbase
Operational Insights Clusters

Get Operational Insights Cluster Details

Changed on

Gets the details of a single Operational Insights cluster.

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

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
get/v4/organizations/{organizationId}/projects/{projectId}/operationalInsightsClusters/{analyticsClusterId}

Request

Response

Successfully retrieved details of the Operational Insights cluster.

idstring uuid required

UUID of the analytics cluster.

namestring required

Name of the analytics cluster

descriptionstring

The description of the analytics cluster.

cloudProviderstring required

Cloud provider selection is currently limited to Amazon Web Services (AWS).

regionstring required

Which region should the analytics cluster be deployed in.

nodesinteger required

The number of nodes.

currentState'deploying' | 'deploymentFailed' | 'destroying' | 'destroyFailed' | 'healthy' | 'scaling' | 'scaleFailed' | 'turningOff' | 'turningOffFailed' | 'turnedOff' | 'turningOn' | 'turningOnFailed' | 'restoring' | 'restoringFailed' | 'peering' | 'upgrading' required

Example response

{
  "id": "ffffffff-aaaa-1414-eeee-000000000000",
  "name": "My-first-analytics-cluster",
  "description": "I won him in a game of hook a duck at a carnival",
  "cloudProvider": "aws",
  "region": "us-east-2",
  "nodes": 3,
  "currentState": "deploying",
  "support": {
    "plan": "enterprise",
    "timezone": "ET"
  },
  "compute": {
    "cpu": 4,
    "ram": 16
  },
  "availability": {
    "type": "single"
  }
}

Changes