Cadence Cluster V2

Create a Cadence cluster

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

Creates a PCI compliant cluster, see PCI Compliance.

Array of objects (CadenceSharedProvisioningV2) <= 1 items

Settings for SHARED provisioning. Must not be defined with STANDARD provisioning options.

Array of objects (TwoFactorDeleteSettingsV2) <= 1 items
useCadenceWebAuth
required
boolean

Enable Authentication for Cadence Web

required
Array of objects (CadenceDataCentreV2)

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"
cadenceVersion
required
string[0-9]+\.[0-9]+\.[0-9]+

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

  • 0.22.4
  • 0.24.0

Array of objects (CadenceStandardProvisioningV2) <= 1 items

Settings for STARDARD provisioning. Must not be defined with SHARED provisioning options.

privateNetworkCluster
required
boolean

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

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

Name of the cluster.

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"
Array of objects (AwsArchivalV2) <= 1 items

Cadence AWS Archival settings

Responses
202

Cadence Cluster provisioning requested.

post/cluster-management/v2/resources/applications/cadence/clusters/v2/
Request samples
application/json
{
  • "cadenceVersion": "0.22.4",
  • "dataCentres": [
    ],
  • "name": "MyCadenceCluster",
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "standardProvisioning": [
    ],
  • "useCadenceWebAuth": true
}
Response samples
application/json
{
  • "cadenceVersion": "0.22.4",
  • "dataCentres": [
    ],
  • "name": "MyCadenceCluster",
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "standardProvisioning": [
    ],
  • "useCadenceWebAuth": true
}

Get Cadence cluster details.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

Id of the active cluster

Responses
200

Cadence cluster details retrieved.

get/cluster-management/v2/resources/applications/cadence/clusters/v2/{clusterId}
Request samples
Response samples
application/json
{
  • "cadenceVersion": "0.22.4",
  • "dataCentres": [
    ],
  • "name": "MyCadenceCluster",
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "standardProvisioning": [
    ],
  • "useCadenceWebAuth": true
}

Update a Cadence cluster

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

Id of the active cluster

Request Body schema: application/json
required
Array of objects (CadenceDataCentreV2) = 1 items

List of data centre settings.

Responses
202

Cadence cluster update request accepted.

404

Cadence cluster not found.

put/cluster-management/v2/resources/applications/cadence/clusters/v2/{clusterId}
Request samples
application/json
{
  • "dataCentres": [
    ]
}
Response samples
application/json
{
  • "cadenceVersion": "0.22.4",
  • "dataCentres": [
    ],
  • "name": "MyCadenceCluster",
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "PRODUCTION",
  • "standardProvisioning": [
    ],
  • "useCadenceWebAuth": true
}

Delete cluster

Delete an active cluster

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

Id of the active cluster

Responses
204

Cluster delete requested.

delete/cluster-management/v2/resources/applications/cadence/clusters/v2/{clusterId}
Request samples