v1

latestSwagger 2.02026-07-17586981.0 KB

cluster

Provision a new cluster

Provisions a Cluster by setting up listening interfaces for each node.

post/cluster

Query parameters

data_centersstring

For convenience, use this parameter to provision a cluster by providing a data center specification. Accepts a comma separated list of DC configurations. i.e. "3,4,5" sets up 3 data centers with 3, 4, and 5 nodes respectively.

Note: If this is provided the request body is ignored.

cassandra_versionstring

The Cassandra version of this Cluster. This only applies if data_centers is specified.

dse_versionstring

The DSE version of this Cluster. This only applies if data_centers is specified.

namestring

The name to give this Cluster. This only applies if data_centers is specified.

activity_logboolean

Whether or not to enable activity logging of queries. By default falls back to global behavior (which itself defaults to true).

{"stackTrail":"paths:/cluster:post:parameters:5:schema","oasType":"schema","type":"unknown"}

The number of tokens (virtual nodes) for each node. By default is 1.

Request body

idinteger

namestring required

cassandra_versionstring

dse_versionstring

Example request

{
  "name": "cluster0",
  "dse_version": "5.0.8",
  "data_centers": [
    {
      "name": "dc0",
      "nodes": [
        {
          "name": "node0",
          "peer_info": {
            "rack": "rack0"
          }
        },
        {
          "name": "node1",
          "peer_info": {
            "rack": "rack1"
          }
        },
        {
          "name": "node2",
          "peer_info": {
            "rack": "rack2"
          }
        }
      ]
    },
    {
      "name": "dc1",
      "nodes": [
        {
          "name": "node0"
        },
        {
          "name": "node1"
        }
      ]
    }
  ]
}

Response

Created

idinteger

namestring required

cassandra_versionstring

dse_versionstring

Example response

{
  "name": "cluster0",
  "dse_version": "5.0.8",
  "data_centers": [
    {
      "name": "dc0",
      "nodes": [
        {
          "name": "node0",
          "peer_info": {
            "rack": "rack0"
          }
        },
        {
          "name": "node1",
          "peer_info": {
            "rack": "rack1"
          }
        },
        {
          "name": "node2",
          "peer_info": {
            "rack": "rack2"
          }
        }
      ]
    },
    {
      "name": "dc1",
      "nodes": [
        {
          "name": "node0"
        },
        {
          "name": "node1"
        }
      ]
    }
  ]
}