COcouchbase
Operational Insights Clusters

List Organization Level Operational Insights Clusters

Changed on

Lists all the Operational Insights clusters for an organization.

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}/operationalInsightsClusters

Request

Query parameters

pageinteger

Sets the page you would like to view.

perPageinteger

Sets the number of results you would like to have on each page.

sortBystring[]

Sets the order of how you would like to sort the results and the key you would like to order by. Valid fields to sort the results are: id, cloudProvider, name.

sortDirection'asc' | 'desc'

The order in which the items will be sorted.

Response

Successfully listed all the Operational Insights clusters for the organization.

Example response

{
  "data": [
    {
      "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"
      }
    }
  ],
  "cursor": {
    "pages": {
      "page": 2,
      "next": 3,
      "previous": 1,
      "last": 10,
      "perPage": 10,
      "totalItems": 10
    },
    "hrefs": {
      "first": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "last": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "previous": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "next": "https://cloud.couchbase.com/v4/users?page=1&perPage=10"
    }
  }
}

Changes