Operations related to scaling a cluster. Includes adding a new data centre and resizing a cluster.
Add new Cluster Data Centre
Provision new cluster data centre to existing cluster.
Request Body schema: application/json
Successfully created Cluster Data Centre
Bad Request
Not Authorized
Forbidden
Cluster not found
Unsupported media type: returned when the payload is in an unsupported format.
Too many requests: returned when more than 35 requests per second are being received by your user.
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
{- "provider": {
- "name": "AWS_VPC",
- "accountName": "test-account",
- "customVirtualNetworkId": "string",
- "tags": {
- "testTagKey": "testKeyValue"
}, - "resourceGroup": "null",
- "diskEncryptionKey": "null"
}, - "dataCentre": "US_WEST_2",
- "name": "US_WEST_2",
- "network": "192.168.0.0/18",
- "storageNetwork": "192.168.1.0/24",
- "nodeSize": "t3.small",
- "bundles": [
- {
- "bundle": "APACHE_CASSANDRA",
- "version": "3.11.4",
- "options": {
- "authnAuthz": "true",
- "clientEncryption": "false"
}
}
], - "rackAllocation": {
- "numberOfRacks": 3,
- "nodesPerRack": 1
}
}- 202
- 400
- 404
- 415
- 429
{- "message": "Cluster Data Centre created in the specified cluster"
}Get resize operations for a CDC
path Parameters
Successfully returned the cdc resize operation
Bad Request
Not Authorized
Forbidden
Cluster/CDC not found
Unsupported media type: returned when the payload is in an unsupported format.
Too many requests: returned when more than 35 requests per second are being received by your user.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
- 200
- 400
- 404
- 415
- 429
[- {
- "id": "string",
- "cdc": "fc17b1e1-9f63-4465-9ddb-1006810e6d04",
- "params": {
- "concurrentResizes": 0,
- "notifySupportContacts": true,
- "replaceParams": {
- "mode": "KEEP_STORAGE",
- "newSize": "string",
- "gracefulShutdown": true,
- "checkPeers": true,
- "backupDurationThreshold": "string",
- "bundleStartEnabled": true,
- "backupBandwidth": "string",
- "backupConcurrentUploads": 0,
- "skipNodeSizeAvailabilityCheck": true,
- "forceInstanceShutdown": true
}, - "nodePurpose": "ELASTICSEARCH_DATA_AND_INGEST",
- "excludedNodes": [
- "string"
]
}, - "created": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "provider": "string",
- "dataCentre": "string",
- "completedStatus": "GENESIS",
- "notifyContacts": "string",
- "replaceOps": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "status": "GENESIS",
- "node": "4b7757a9-726e-430e-bdc0-085fbe935636",
- "replacement": "0d5797a7-50c5-42e4-893d-e90cf0476063",
- "params": {
- "mode": "KEEP_STORAGE",
- "newSize": "string",
- "gracefulShutdown": true,
- "checkPeers": true,
- "backupDurationThreshold": "string",
- "bundleStartEnabled": true,
- "backupBandwidth": "string",
- "backupConcurrentUploads": 0,
- "skipNodeSizeAvailabilityCheck": true,
- "forceInstanceShutdown": true
}, - "resizeOp": "b66edd1b-2e4b-4a85-ab97-1546e2be962b",
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "backupTriggered": "2019-08-24T14:15:22Z",
- "backupCompleted": "2019-08-24T14:15:22Z",
- "restoreCompleted": "2019-08-24T14:15:22Z",
- "failedStatus": "GENESIS",
- "restore": "b2478bfc-4557-4807-aa97-318378b7be6c",
- "details": "string",
- "techopsAlerted": "2019-08-24T14:15:22Z",
- "addedDisk": "string"
}
], - "skipInitialCheck": true,
- "details": "string",
- "techopsAlerted": "2019-08-24T14:15:22Z",
- "firstStateHealthCheckFailure": "2019-08-24T14:15:22Z",
- "initiatedBy": "string",
- "ignoreFeatureState": true,
- "riemaintRuleIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "sshMessageId": "08fb077b-04a3-486d-ab23-81b744027abc"
}
]Resize an instance
Nodes in a cluster data centre can be resized in-place via the Console or by issuing an API request. Resizing nodes let you scale the CPU core count and memory quota to meet changing demands and is significantly faster than adding additional Cassandra nodes.
path Parameters
Request Body schema: application/jsonrequired
| newNodeSize required | string The desired node size. See https://www.instaclustr.com/support/documentation/useful-information/supported-instances-and-usecases/ for valid values. |
| concurrentResizes required | integer <int32> >= 1 A number, from 1 to the count of nodes in the largest rack, that specifies how many nodes may be resized at the same time. |
| notifySupportContacts required | boolean |
| nodePurpose | string A valid node purpose for the cdc. You can get the allowed node purposes for a CDC by GET /provisioning/v1/{clusterId}/{clusterDataCentreId}/nodepurposes |
Successfully created resize request.
Bad Request
Not Authorized
Forbidden
Resource not found
A resize operation already exists for the specified data centre.
Precondition failed.
Unsupported media type: returned when the payload is in an unsupported format.
Too many requests: returned when more than 35 requests per second are being received by your user.
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
{- "newNodeSize": "m5xl-1600-v2",
- "concurrentResizes": 1,
- "notifySupportContacts": false,
- "nodePurpose": "ELASTICSEARCH_DEDICATED_MASTER"
}- 202
- 400
- 404
- 409
- 412
- 415
- 429
{- "message": "instance resize request accepted"
}Retrieve compatible node sizes for resize
Retrieve a map between NodePurpose with a list of their valid node sizes for resize.
Successfully retrieved all NodePurpose with their valid node sizes supported for resize.
Bad Request
Not Authorized
Forbidden
Not Found
Unsupported media type: returned when the payload is in an unsupported format.
Too many requests: returned when more than 35 requests per second are being received by your user.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
- 200
- 400
- 404
- 415
- 429
"{\"ELASTICSEARCH_MASTER\":[\"m5l-250\"],\"ELASTICSEARCH_KIBANA\":[\"m5l-250\"]}"Get details for a resize operation
Successfully returned the cdc resize operation details
Bad Request
Not Authorized
Forbidden
Operation not found
Unsupported media type: returned when the payload is in an unsupported format.
Too many requests: returned when more than 35 requests per second are being received by your user.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
- 200
- 400
- 404
- 415
- 429
{- "id": "string",
- "cdc": "string",
- "concurrentResizes": 0,
- "notifyContacts": "string",
- "nodePurpose": "ELASTICSEARCH_DATA_AND_INGEST",
- "newSize": "string",
- "created": "2019-08-24T14:15:22Z",
- "completed": "2019-08-24T14:15:22Z",
- "completedStatus": "string",
- "replaceOps": [
- {
- "id": "string",
- "status": "GENESIS",
- "node": "string",
- "replacement": "string",
- "resizeOp": "string",
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "failedStatus": "GENESIS"
}
]
}Cancel resize CDC operation
Cancel an active resize cluster data centre operation.
Node Purposes
Bad Request
Not Authorized
Forbidden
Resource not found
Unsupported media type: returned when the payload is in an unsupported format.
Too many requests: returned when more than 35 requests per second are being received by your user.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
- 200
- 400
- 404
- 415
- 429
[- "ELASTICSEARCH_DATA_AND_INGEST"
]