Instaclustr Logo
Powered by Redocly

Cassandra Cluster V2

Create a Cassandra cluster.

SecurityBasic Authentication
Request
Request Body schema: application/json
pciComplianceMode
required
boolean

Creates a PCI compliant cluster, see PCI Compliance.

Array of objects (TwoFactorDeleteSettingsV2) <= 1 items
required
Array of objects (CassandraDataCentreV2) non-empty

List of data centre settings.

currentClusterOperationStatus
string (CurrentClusterOperationStatusV2)

Indicates if the cluster is currently performing any restructuring operation such as being created or resized

Enum: "NO_OPERATION" "OPERATION_IN_PROGRESS" "OPERATION_FAILED"
Array of objects (SparkDetailsV2) <= 1 items

Adds the specified version of Apache Spark to the Cassandra cluster.

privateNetworkCluster
required
boolean

Creates the cluster with private network only, see Private Network Clusters.

cassandraVersion
required
string[0-9]+\.[0-9]+\.[0-9]+

Version of Cassandra to run on the cluster. Available versions:

  • 4.0.4
  • 3.11.13

luceneEnabled
required
boolean

Adds Apache Lucene to the Cassandra cluster.

passwordAndUserAuth
required
boolean

Enables Password Authentication and User Authorization.

name
required
string [ 3 .. 32 ] characters [a-zA-Z0-9][a-zA-Z0-9_-]*

Name of the cluster.

bundledUseOnly
boolean

Provision this cluster for Bundled Use only.

slaTier
required
string (SlaTierV2)

SLA Tier of the cluster. Non-production clusters may receive lower priority support and reduced SLAs. Production tier is not available when using Developer class nodes. See SLA Tier for more information.

Enum: "PRODUCTION" "NON_PRODUCTION"
Responses
202

Cassandra Cluster provisioning requested.

post/cluster-management/v2/resources/applications/cassandra/clusters/v2
Request samples
application/json
{
  • "cassandraVersion": "[x.y.z]",
  • "dataCentres": [
    ],
  • "luceneEnabled": true,
  • "name": "MyTestCluster",
  • "passwordAndUserAuth": true,
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "spark": [
    ],
  • "twoFactorDelete": [
    ]
}
Response samples
application/json
{
  • "cassandraVersion": "[x.y.z]",
  • "dataCentres": [
    ],
  • "luceneEnabled": true,
  • "name": "MyTestCluster",
  • "passwordAndUserAuth": true,
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "spark": [
    ],
  • "twoFactorDelete": [
    ]
}

Get Cassandra cluster details.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Responses
200

Cassandra cluster details retrieved.

get/cluster-management/v2/resources/applications/cassandra/clusters/v2/{clusterId}
Request samples 
Response samples 
application/json
{
  • "cassandraVersion": "[x.y.z]",
  • "dataCentres": [
    ],
  • "luceneEnabled": true,
  • "name": "MyTestCluster",
  • "passwordAndUserAuth": true,
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "spark": [
    ],
  • "twoFactorDelete": [
    ]
}
Update Cassandra Cluster Details
SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
 
Request Body schema: application/json
required
Array of objects (CassandraDataCentreV2)   non-empty 
List of datacentre settings.


 
Responses 
202
Cassandra cluster update request accepted.


404
Cassandra cluster not found


put/cluster-management/v2/resources/applications/cassandra/clusters/v2/{clusterId}
Request samples 
application/json
{
  • "dataCentres": [
    ]
}
Response samples 
application/json
{
  • "cassandraVersion": "[x.y.z]",
  • "dataCentres": [
    ],
  • "luceneEnabled": true,
  • "name": "MyTestCluster",
  • "passwordAndUserAuth": true,
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "spark": [
    ],
  • "twoFactorDelete": [
    ]
}
Delete cluster
Delete an active cluster.


SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
 
Responses 
204
Cluster delete requested.


delete/cluster-management/v2/resources/applications/cassandra/clusters/v2/{clusterId}
Request samples 
➔ Next to Cluster Network Firewall Rule V2