Provisioning API

Menu

The provisioning API allows most provisioning actions available on the console (GUI) to be carried out via a REST API (eg create, view, and delete clusters).

This is most commonly used as part of an automated testing process where you want to provision a complete environment from scratch.

For increased security, we only enable the provisioning API when specifically requested. Email support@instaclustr.com and request to have it enabled on your account.

Pricing

Clusters created via the provisioning API are charged at our standard on-demand rates listed on the Pricing page in our console.

Free trial clusters can be created under the same terms as clusters created via the GUI console.

Availability

Our APIs are engineered and operated for high levels of availability. However, you should not expect that our APIs have the same level of availability as a managed cluster and you should not build any dependency on the APIs into availability of your service. While we do not provide formal SLAs for the APIs, we aim for 99.95% availability (ie up to ~20 mins downtime per month). Longer maintenance outages may be schedule with appropriate notice. Consequently, any service dependent on the APIs should be able to cope gracefully with periods of unavailability of up to a few minutes. Planned and unplanned outages are communicated via https://status.instaclustr.com/.

Authentication

All requests to the API must use Basic Authentication and contain a valid username and either a provisioning API key or a read-only provisioning API Key.

The provisioning API key has full access to all the endpoints while the read-only provisioning key can only perform GET requests to endpoints.

The API keys are created per user, per account.

Accessing your API keys

API keys can be retrieved at any time from the secure page in the console by going to Account > API Keys.

Request Rate

Note that requests to the provisioning API are rate limited. Individual IPs may only make 1 request per 2.5 seconds. Exceeding this rate will return a 429 error code until that IP’s request threshold falls below this limit.

Create Cluster

The following endpoint has extended functionality with support for more of the Instaclustr Managed Service offerings.

Instaclustr continues to support the legacy provisioning api (below).

To provision a new cluster make a POST request to https://api.instaclustr.com/provisioning/v1/extended/with the JSON body:

Example 1: Apache Cassandra with Spark and Zeppelin

Example 2: Apache Kafka

Additionally, data at rest encryption is supported for AWS_VPC clusters. Add diskEncryptionKey to the provision cluster request in the provider section:

You can find out more about disk encryption keys here.

API Specification

Allowed Values

FieldAllowed ValuesDefault value
clusterNameString

May contain a combination of letters, numbers and underscores with a maximum length of 32 characters.

bundlesArray of bundle information.
See below for bundle options.
provider.nameAWS_VPC, AZURE, SOFTLAYER_BARE_METAL, GCP (Multi-dc provisioning not currently supported through API.)
provider.accountNameOptional

String

For customers running in their own account. Your provider account can be found on the ‘Account’ tab on the console, or the “Provider Account” property on any existing cluster.

For customers running in Instaclustr account, this property may be omitted.

null
provider.tagsOptional
AWS_VPC only If specified, the value is a map from tag key to value. For restrictions, refer to the AWS User Guide. Tags are defined per cluster and will be applied to every instance in the cluster.
null
provider.resourceGroupOptional
AZURE only
provider.accountName must be setStringIf specified, the value is name for an Azure Resource Group which the resources will be provisioned into.
null
nodeSizeDesired node size. See ‘Data centres and node sizes’ reference table.
slaTierOptional

PRODUCTION, NON-PRODUCTION

Non-production clusters may receive lower priority support and reduced SLAs. Production tier is not available when using Developer class nodes. You can find more information here.

PRODUCTION
dataCentreDesired data centre. See ‘Data centres and node sizes’ reference table.
clusterNetworkThe private network address block for the cluster specified using CIDR address notation.

The network must have a prefix length between /12 and /22 and must be part of a private address space.

10.224.0.0/12
privateNetworkClusterOptional

true/false

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

false
rackAllocation.numberOfRacksNumber of racks to use when allocating nodes. Max allowed is 5
rackAllocation.nodesPerRackNumber of nodes per rack. Max allowed is 10
firewallRulesOptional

Array of CIDR addresses permitted to connect to the applications running on this cluster.

Additional addresses may be added later in Cluster Settings (console).

null

Bundle options

Instaclustr refers to the applications running on a cluster as bundles, the options for each bundle are listed below.

Note: The bundle versions listed are defaults for most accounts, additional versions may be available for your account. You can consult the Instaclustr Console for information about which bundle versions are available for you.

Cassandra Bundle options

Allowed Values

FieldAllowed ValuesDefault Value
bundleAPACHE_CASSANDRA

Compatible bundles:

SPARK and/or ZEPPELIN

versionAvailable options:

apache-cassandra-2.1.19

apache-cassandra-2.2.13

apache-cassandra-3.0.14

apache-cassandra-3.0.17

apache-cassandra-3.0.18

apache-cassandra-3.11

apache-cassandra-3.11.3

apache-cassandra-3.11.4.ic1

options.authnAuthzOptional

true/false

false
options.clientEncryptionOptional

true/false

false
options.usePrivateBroadcastRPCAddressOptional

true/false

false
options.luceneEnabledOptional

true/false

false
options.backupEnabledOptional

true/false

true

Kafka Bundle options

Allowed Values

FieldAllowed ValuesDefault Value
bundleKAFKA

Compatible bundles:

KAFKA_REST_PROXY and/or KAFKA_SCHEMA_REGISTRY

versionAvailable options:

2.1.1

2.3.0

 

Deprecated options:

apache-kafka:2.1.1.ic1

apache-kafka:2.3.0

options.clientEncryptionOptional

true/false

false
options.numberPartitionsOptional

Integer

Number of nodes
options.autoCreateTopicsOptional

true/false

true
options.deleteTopicsOptional

true/false

true

 

Addon Bundle options:

Addon bundles cannot be provisioned by themselves.

Spark Bundle options

Allowed Values

FieldAllowed ValuesDefault Value
bundleSPARK
versionAvailable options:

apache-spark:2.1.3

apache-spark:2.1.3.ic1

apache-spark:2.3.2

options.clientEncryptionOptional

true/false

false
options.passwordAuthenticationOptional

true/false

false

 

Zeppelin Bundle options

Allowed Values

FieldAllowed ValuesDefault Value
bundleZEPPELIN
versionAvailable options:

apache-zeppelin:0.8.0-spark-2.3.2

apache-zeppelin:0.7.1-spark-2.1.1

 

Kafka Rest Proxy Bundle options

Allowed Values

FieldAllowed ValuesDefault Value
bundleKAFKA_REST_PROXY
versionAvailable options:

5.0.0

Deprecated options:

kafka-rest-proxy:5.0.0

 

Kafka Schema Registry Bundle options

Allowed Values

FieldAllowed ValuesDefault Value
bundleKAFKA_SCHEMA_REGISTRY
versionAvailable options:

5.0.0

Deprecated options:

kafka-schema-registry:5.0.0

 

Resize Cluster

To resize an instance make a post request to https://api.instaclustr.com/provisioning/v1/<clusterId>/clusterDataCentreId

/resize with a json body, for example,

API Specification

 

FieldAllowed ValuesDefault values
newNodeSizeDesired node size. See resizable node size
concurrentResizes1,2 or 3
notifySupportContactstrue/false

Create Cluster (Legacy)

To provision a new cluster make a POST request to https://api.instaclustr.com/provisioning/v1/ with the JSON body:

Additionally, data at rest encryption is supported for AWS_VPC clusters. Add diskEncryptionKey to the provision cluster request:

Note: Refer our support article on encryption keys API to retrieve the ‘diskEncryptionKey’ UUID.

If the JSON is valid (see allowed values below), the API will respond with 202 Accepted and a JSON containing the cluster id.

Depending on the underlying infrastructure provider, it can take up to 10 minutes for the cluster to reach a usable state. You can check the status of provisioning using the cluster status endpoint, or via the console.

VPC Peering must be set up after the cluster is created. See below for VPC Peering APIs.

Allowed Values

FieldAllowed Values

clusterName

May contain a combination of letters, numbers and underscores with a maximum length of 32 characters.

provider

AWS_VPC, AZURE, SOFTLAYER_BARE_METAL, GCP (Multi-dc provisioning not currently supported through API.)

account

[New Feature]

Optional for customers running in their own account. Your provider account can be found on the ‘Account’ tab on the console, or the “Provider Account” property on any existing cluster.

For customers running in Instaclustr account, this property may be omitted.

version

Current version of Cassandra:

Please refer to the console in the Create cluster page for a list of cassandra versions available to you. They will take the form apache-cassandra-x.x.xx. 

Email support@instaclustr.com for other supported versions.

size

See ‘Data centres and node sizes’ reference table below

region.dataCentre

See ‘Data centres and node sizes’ reference table below

region.clientEncryption

MUST be false on developer (t2) nodes

region.defaultNetwork

This feature has been deprecated and is no longer mandatory. Use of region.cdcNetwork is recommended instead.

The private network address block for the cluster specified using CIDR address notation. The network must have a prefix length between /12 and /22 and must be part of a private address space. Defaults to “10.224.0.0/12”.

region.cdcNetwork

The value is the private network address block for the data centre specified using CIDR address notation.

If defaultNetwork is specified, cdcNetwork must be a subnet of cluster network specified in region.defaultNetwork and must have a prefix length between region.defaultNetwork’s prefix + 4 and /26. For example if region.defaultNetwork is “10.224.0.0/18” , region.cdcNetwork must have prefix length between /22 and /26 so “10.224.0.0/25″ would be a valid value.

If defaultNetwork is not specified, cdcNetwork must have a prefix length between /16 and /26 and must be part of a private address space.

 

region.firewallRules

Array of CIDR addresses permitted to connect to this cluster. Additional addresses may be added later in Cluster Settings (console).

region.rackAllocation

See ‘Racks’ reference table below

tags

This field is optional. If specified, the value is a map from tag key to value. For restrictions, refer to the AWS User Guide. Tags are defined per cluster and will be applied to every instance in the cluster. Tags are currently an AWS-only feature and will be ignored for other providers.

slaTier

This field is optional, and it accepts two values, PRODUCTION (default) and NON_PRODUCTION. Non-production clusters may receive lower priority support and reduced SLAs. Production tier is not available when using Developer class nodes. You can find more information here.

Cluster Status

To retrieve status of a cluster, make a GET request to https://api.instaclustr.com/provisioning/v1/<clusterId>

The API will respond with a JSON containing the following information:

Delete Cluster

To delete a cluster, make a DELETE request to https://api.instaclustr.com/provisioning/v1/<clusterId>

The API will respond with 202 Accepted and JSON with message “”Cluster has been marked for deletion.”

List all clusters

You can retrieve a list of all active clusters in your account by making a GET request to https://api.instaclustr.com/provisioning/v1/.

The response will contain an array of clusters:

Firewall rules

Create firewall rule

To provision a new firewall rule make a POST request to https://api.instaclustr.com/provisioning/v1/<clusterId>/firewallRules with the JSON body:

If the JSON is valid (see allowed values below), the API will respond with 202 Accepted

It can take up to 10 minutes for the firewall rule to reach a useable state. You may check the status of provisioning using the list firewall rules endpoint, or via the console

Delete firewall rule

To delete an existing firewall rule make a DELETE request to https://api.instaclustr.com/provisioning/v1/<clusterId>/firewallRules with the JSON body:

If the JSON is valid (see allowed values below), the API will respond with 202 Accepted. Note that the API responds with 202 Accepted for any valid IP address, even if it is not referenced in the cluster. To verify deletion, use the below command for listing firewall rules, or check the “Cassandra Allowed Addresses” section in the console

Upon deletion, you may need to wait up to 10 minutes before provisioning a replacement using the same network.

Allowed Values

FieldAllowed Values

network

Must be a valid IPv4 CIDR.

type

CASSANDRA, SPARK, SPARK_JOBSERVER

List firewall rules

You can obtain a list of all firewall rules for a cluster by making a GET request to https://api.instaclustr.com/provisioning/v1/<clusterId>/firewallRules

Sample response: 

[ { "network":"10.0.0.0/16", "rules":[ { "type":"CASSANDRA", "status":"RUNNING" }, { "type":"SPARK", "status":"RUNNING" }, { "type":"SPARK_JOBSERVER", "status":"RUNNING" } ] }, { "network":"192.168.0.0/24", "rules":[ { "type":"CASSANDRA", "status":"RUNNING" } ] } ]

VPC Peering Connections

List VPC Peering Connections

To list the details for all the connections for a given Cluster Data Centre make a GETrequest to https://api.instaclustr.com/provisioning/v1/vpc-peering/<clusterDataCentreId>

The response will contain an array of VPC Peering Connections:

List VPC Peering Connection

To List the details for a given VPC Peering Connection make a GET request to https://api.instaclustr.com/provisioning/v1/vpc-peering/<clusterDataCentreId>/<vpcPeeringConnectionId>

Here is an example response:

Create VPC Peering Request

To create a new VPC Peering Connection request make a POST request to https://api.instaclustr.com/provisioning/v1/vpc-peering/<clusterDataCentreId> with JSON body:

Note: the attribute “peerRegion” is optional, and will be assigned to the default region if unspecified.

If successful the call will return with status Accepted 202 and return the id of the new connection:

Delete VPC Peering Request/Connection

To delete a VPC Peering Connection make a DELETE call to https://api.instaclustr.com/provisioning/v1/vpc-peering/<clusterDataCentreId>/<vpcPeeringConnectionId>. If successful the call will return with status Accepted 202.

Reference Data: Data centres and node sizes

providerdataCentresizePlanData Centre Name
AWS_VPCAP_NORTHEAST_1m4l-250EBS: tinyAsia Pacific (Tokyo)
AWS_VPCAP_NORTHEAST_1m4xl-400EBS: smallAsia Pacific (Tokyo)
AWS_VPCAP_NORTHEAST_1m4xl-800EBS: balancedAsia Pacific (Tokyo)
AWS_VPCAP_NORTHEAST_1m4xl-1600EBS: bulk storageAsia Pacific (Tokyo)
AWS_VPCAP_NORTHEAST_1m3.xlargeSmallAsia Pacific (Tokyo)
AWS_VPCAP_NORTHEAST_1c3.2xlargeMediumAsia Pacific (Tokyo)
AWS_VPCAP_NORTHEAST_1i2.2xlargeExtra LargeAsia Pacific (Tokyo)
AWS_VPCAP_NORTHEAST_1t2.smallStarterAsia Pacific (Tokyo)
AWS_VPCAP_NORTHEAST_1t2.mediumProfessionalAsia Pacific (Tokyo)
AWS_VPCAP_SOUTHEAST_1m4l-250EBS: tinyAsia Pacific (Singapore)
AWS_VPCAP_SOUTHEAST_1m4xl-400EBS: smallAsia Pacific (Singapore)
AWS_VPCAP_SOUTHEAST_1m4xl-800EBS: balancedAsia Pacific (Singapore)
AWS_VPCAP_SOUTHEAST_1m4xl-1600EBS: bulk storageAsia Pacific (Singapore)
AWS_VPCAP_SOUTHEAST_1m3.xlargeSmallAsia Pacific (Singapore)
AWS_VPCAP_SOUTHEAST_1c3.2xlargeMediumAsia Pacific (Singapore)
AWS_VPCAP_SOUTHEAST_1i2.2xlargeExtra LargeAsia Pacific (Singapore)
AWS_VPCAP_SOUTHEAST_1t2.smallStarterAsia Pacific (Singapore)
AWS_VPCAP_SOUTHEAST_1t2.mediumProfessionalAsia Pacific (Singapore)
AWS_VPCAP_SOUTHEAST_2m4l-250EBS: tinyAsia Pacific (Sydney)
AWS_VPCAP_SOUTHEAST_2m4xl-400EBS: smallAsia Pacific (Sydney)
AWS_VPCAP_SOUTHEAST_2m4xl-800EBS: balancedAsia Pacific (Sydney)
AWS_VPCAP_SOUTHEAST_2m4xl-1600EBS: bulk storageAsia Pacific (Sydney)
AWS_VPCAP_SOUTHEAST_2m3.xlargeSmallAsia Pacific (Sydney)
AWS_VPCAP_SOUTHEAST_2c3.2xlargeMediumAsia Pacific (Sydney)
AWS_VPCAP_SOUTHEAST_2i2.2xlargeExtra LargeAsia Pacific (Sydney)
AWS_VPCAP_SOUTHEAST_2t2.smallStarterAsia Pacific (Sydney)
AWS_VPCAP_SOUTHEAST_2t2.mediumProfessionalAsia Pacific (Sydney)
AWS_VPCEU_CENTRAL_1m4l-250EBS: tinyEU Central (Frankfurt)
AWS_VPCEU_CENTRAL_1t2.smallStarterEU Central (Frankfurt)
AWS_VPCEU_CENTRAL_1t2.mediumProfessionalEU Central (Frankfurt)
AWS_VPCEU_CENTRAL_1m3.xlargeSmallEU Central (Frankfurt)
AWS_VPCEU_CENTRAL_1c3.2xlargeMediumEU Central (Frankfurt)
AWS_VPCEU_CENTRAL_1i2.2xlargeExtra LargeEU Central (Frankfurt)
AWS_VPCEU_CENTRAL_1m4xl-400EBS: smallEU Central (Frankfurt)
AWS_VPCEU_CENTRAL_1m4xl-800EBS: balancedEU Central (Frankfurt)
AWS_VPCEU_CENTRAL_1m4xl-1600EBS: bulk storageEU Central (Frankfurt)
AWS_VPCEU_WEST_1m4l-250EBS: tinyEU West (Ireland)
AWS_VPCEU_WEST_1m4xl-400EBS: smallEU West (Ireland)
AWS_VPCEU_WEST_1m4xl-800EBS: balancedEU West (Ireland)
AWS_VPCEU_WEST_1m4xl-1600EBS: bulk storageEU West (Ireland)
AWS_VPCEU_WEST_1m3.xlargeSmallEU West (Ireland)
AWS_VPCEU_WEST_1c3.2xlargeMediumEU West (Ireland)
AWS_VPCEU_WEST_1i2.2xlargeExtra LargeEU West (Ireland)
AWS_VPCEU_WEST_1t2.smallStarterEU West (Ireland)
AWS_VPCEU_WEST_1t2.mediumProfessionalEU West (Ireland)
AWS_VPCEU_WEST_1m42xl-1600Special Size: m4.2xlargeEU West (Ireland)
AWS_VPCSA_EAST_1m3.xlargeSmallSouth America (São Paulo)
AWS_VPCSA_EAST_1c3.2xlargeMediumSouth America (São Paulo)
AWS_VPCSA_EAST_1t2.smallStarterSouth America (São Paulo)
AWS_VPCSA_EAST_1t2.mediumProfessionalSouth America (São Paulo)
AWS_VPCUS_EAST_1m4l-250EBS: tinyUS East (Northern Virginia)
AWS_VPCUS_EAST_1m4xl-400EBS: smallUS East (Northern Virginia)
AWS_VPCUS_EAST_1m4xl-800EBS: balancedUS East (Northern Virginia)
AWS_VPCUS_EAST_1m4xl-1600EBS: bulk storageUS East (Northern Virginia)
AWS_VPCUS_EAST_1m3.xlargeSmallUS East (Northern Virginia)
AWS_VPCUS_EAST_1c3.2xlargeMediumUS East (Northern Virginia)
AWS_VPCUS_EAST_1i2.2xlargeExtra LargeUS East (Northern Virginia)
AWS_VPCUS_EAST_1t2.smallStarterUS East (Northern Virginia)
AWS_VPCUS_EAST_1t2.mediumProfessionalUS East (Northern Virginia)
AWS_VPCUS_EAST_1m42xl-1600Special Size: m4.2xlargeUS East (Northern Virginia)
AWS_VPCUS_WEST_1m4l-250EBS: tinyUS West (Northern California)
AWS_VPCUS_WEST_1m4xl-400EBS: smallUS West (Northern California)
AWS_VPCUS_WEST_1m4xl-800EBS: balancedUS West (Northern California)
AWS_VPCUS_WEST_1m4xl-1600EBS: bulk storageUS West (Northern California)
AWS_VPCUS_WEST_1m3.xlargeSmallUS West (Northern California)
AWS_VPCUS_WEST_1c3.2xlargeMediumUS West (Northern California)
AWS_VPCUS_WEST_1i2.2xlargeExtra LargeUS West (Northern California)
AWS_VPCUS_WEST_1t2.smallStarterUS West (Northern California)
AWS_VPCUS_WEST_1t2.mediumProfessionalUS West (Northern California)
AWS_VPCUS_WEST_2m4l-250EBS: tinyUS West (Oregon)
AWS_VPCUS_WEST_2m4xl-400EBS: smallUS West (Oregon)
AWS_VPCUS_WEST_2m4xl-800EBS: balancedUS West (Oregon)
AWS_VPCUS_WEST_2m4xl-1600EBS: bulk storageUS West (Oregon)
AWS_VPCUS_WEST_2m3.xlargeSmallUS West (Oregon)
AWS_VPCUS_WEST_2c3.2xlargeMediumUS West (Oregon)
AWS_VPCUS_WEST_2i2.2xlargeExtra LargeUS West (Oregon)
AWS_VPCUS_WEST_2t2.smallStarterUS West (Oregon)
AWS_VPCUS_WEST_2t2.mediumProfessionalUS West (Oregon)
AZURECANADA_CENTRALStandard_DS12_v2-512Premium: smallCanada Central (Toronto)
AZURECANADA_CENTRALStandard_DS12_v2-1023Premium: balancedCanada Central (Toronto)
AZURECANADA_CENTRALStandard_DS12_v2-2046Premium: bulk storageCanada Central (Toronto)
AZURECANADA_CENTRALStandard_DS2_v2-256Premium: tinyCanada Central (Toronto)
AZURECANADA_EASTStandard_DS12_v2-512Premium: smallCanada East (Quebec City)
AZURECANADA_EASTStandard_DS12_v2-1023Premium: balancedCanada East (Quebec City)
AZURECANADA_EASTStandard_DS12_v2-2046Premium: bulk storageCanada East (Quebec City)
AZURECANADA_EASTStandard_DS2_v2-256Premium: tinyCanada East (Quebec City)
AZURECENTRAL_USStandard_DS12_v2-512Premium: smallCentral US (Iowa)
AZURECENTRAL_USStandard_DS12_v2-1023Premium: balancedCentral US (Iowa)
AZURECENTRAL_USStandard_DS12_v2-2046Premium: bulk storageCentral US (Iowa)
AZURECENTRAL_USStandard_DS2_v2-256Premium: tinyCentral US (Iowa)
AZURECENTRAL_USStandard_DS13_v2-2046Premium: extra largeCentral US (Iowa)
AZUREEAST_ASIAStandard_DS12-512Premium: smallEast Asia (Hong Kong)
AZUREEAST_ASIAStandard_DS12-1023Premium: balancedEast Asia (Hong Kong)
AZUREEAST_ASIAStandard_DS12-2046Premium: bulk storageEast Asia (Hong Kong)
AZUREEAST_ASIAStandard_DS2-256Premium: tinyEast Asia (Hong Kong)
AZUREEAST_USStandard_DS12_v2-512Premium: smallEast US (Virginia)
AZUREEAST_USStandard_DS12_v2-1023Premium: balancedEast US (Virginia)
AZUREEAST_USStandard_DS12_v2-2046Premium: bulk storageEast US (Virginia)
AZUREEAST_USStandard_DS2_v2-256Premium: tinyEast US (Virginia)
AZUREEAST_US_2Standard_DS12_v2-512Premium: smallEast US 2 (Virginia)
AZUREEAST_US_2Standard_DS12_v2-1023Premium: balancedEast US 2 (Virginia)
AZUREEAST_US_2Standard_DS12_v2-2046Premium: bulk storageEast US 2 (Virginia)
AZUREEAST_US_2Standard_DS2_v2-256Premium: tinyEast US 2 (Virginia)
AZUREJAPAN_WESTStandard_DS12_v2-512Premium: smallJapan West (Osaka Prefecture)
AZUREJAPAN_WESTStandard_DS12_v2-1023Premium: balancedJapan West (Osaka Prefecture)
AZUREJAPAN_WESTStandard_DS12_v2-2046Premium: bulk storageJapan West (Osaka Prefecture)
AZUREJAPAN_WESTStandard_DS2_v2-256Premium: tinyJapan West (Osaka Prefecture)
AZURENORTH_EUROPEStandard_DS12_v2-512Premium: smallNorth Europe (Ireland)
AZURENORTH_EUROPEStandard_DS12_v2-1023Premium: balancedNorth Europe (Ireland)
AZURENORTH_EUROPEStandard_DS12_v2-2046Premium: bulk storageNorth Europe (Ireland)
AZURENORTH_EUROPEStandard_DS2_v2-256Premium: tinyNorth Europe (Ireland)
AZURESOUTH_CENTRAL_USStandard_DS12_v2-512Premium: smallSouth Central US (Texas)
AZURESOUTH_CENTRAL_USStandard_DS12_v2-1023Premium: balancedSouth Central US (Texas)
AZURESOUTH_CENTRAL_USStandard_DS12_v2-2046Premium: bulk storageSouth Central US (Texas)
AZURESOUTH_CENTRAL_USStandard_DS2_v2-256Premium: tinySouth Central US (Texas)
AZURESOUTHEAST_ASIAStandard_DS12_v2-512Premium: smallSoutheast Asia (Singapore)
AZURESOUTHEAST_ASIAStandard_DS12_v2-1023Premium: balancedSoutheast Asia (Singapore)
AZURESOUTHEAST_ASIAStandard_DS12_v2-2046Premium: bulk storageSoutheast Asia (Singapore)
AZURESOUTHEAST_ASIAStandard_DS2_v2-256Premium: tinySoutheast Asia (Singapore)
AZURESOUTHEAST_ASIAStandard_DS13_v2-2046Premium: extra largeSoutheast Asia (Singapore)
AZUREWEST_EUROPEStandard_DS12_v2-512Premium: smallWest Europe (Netherlands)
AZUREWEST_EUROPEStandard_DS12_v2-1023Premium: balancedWest Europe (Netherlands)
AZUREWEST_EUROPEStandard_DS12_v2-2046Premium: bulk storageWest Europe (Netherlands)
AZUREWEST_EUROPEStandard_DS2_v2-256Premium: tinyWest Europe (Netherlands)
AZUREWEST_USStandard_DS12_v2-512Premium: smallWest US (California)
AZUREWEST_USStandard_DS12_v2-1023Premium: balancedWest US (California)
AZUREWEST_USStandard_DS12_v2-2046Premium: bulk storageWest US (California)
AZUREWEST_USStandard_DS2_v2-256Premium: tinyWest US (California)
SOFTLAYER_BARE_METALAMS01Xeon_1270MediumWestern Europe (Amsterdam 01)
SOFTLAYER_BARE_METALAMS01Xeon_2690LargeWestern Europe (Amsterdam 01)
SOFTLAYER_BARE_METALAMS01Xeon_2690_x2Extra LargeWestern Europe (Amsterdam 01)
SOFTLAYER_BARE_METALAMS03Xeon_1270MediumWestern Europe (Amsterdam 03)
SOFTLAYER_BARE_METALAMS03Xeon_2690LargeWestern Europe (Amsterdam 03)
SOFTLAYER_BARE_METALAMS03Xeon_2690_x2Extra LargeWestern Europe (Amsterdam 03)
SOFTLAYER_BARE_METALDAL01Xeon_1270MediumCentral US (Dallas 01)
SOFTLAYER_BARE_METALDAL01Xeon_2690LargeCentral US (Dallas 01)
SOFTLAYER_BARE_METALDAL01Xeon_2690_x2Extra LargeCentral US (Dallas 01)
SOFTLAYER_BARE_METALDAL05Xeon_1270MediumCentral US (Dallas 05)
SOFTLAYER_BARE_METALDAL05Xeon_2690LargeCentral US (Dallas 05)
SOFTLAYER_BARE_METALDAL05Xeon_2690_x2Extra LargeCentral US (Dallas 05)
SOFTLAYER_BARE_METALDAL06Xeon_1270MediumCentral US (Dallas 06)
SOFTLAYER_BARE_METALDAL06Xeon_2690LargeCentral US (Dallas 06)
SOFTLAYER_BARE_METALDAL06Xeon_2690_x2Extra LargeCentral US (Dallas 06)
SOFTLAYER_BARE_METALDAL07Xeon_1270MediumCentral US (Dallas 07)
SOFTLAYER_BARE_METALDAL07Xeon_2690LargeCentral US (Dallas 07)
SOFTLAYER_BARE_METALDAL07Xeon_2690_x2Extra LargeCentral US (Dallas 07)
SOFTLAYER_BARE_METALDAL09Xeon_1270MediumCentral US (Dallas 09)
SOFTLAYER_BARE_METALDAL09Xeon_2690LargeCentral US (Dallas 09)
SOFTLAYER_BARE_METALDAL09Xeon_2690_x2Extra LargeCentral US (Dallas 09)
SOFTLAYER_BARE_METALFRA02Xeon_1270MediumWestern Europe (Frankfurt 02)
SOFTLAYER_BARE_METALFRA02Xeon_2690LargeWestern Europe (Frankfurt 02)
SOFTLAYER_BARE_METALFRA02Xeon_2690_x2Extra LargeWestern Europe (Frankfurt 02)
SOFTLAYER_BARE_METALHKG02Xeon_1270MediumAsia (Hong Kong 02)
SOFTLAYER_BARE_METALHKG02Xeon_2690LargeAsia (Hong Kong 02)
SOFTLAYER_BARE_METALHKG02Xeon_2690_x2Extra LargeAsia (Hong Kong 02)
SOFTLAYER_BARE_METALHOU02Xeon_1270MediumCentral US (Houston 02)
SOFTLAYER_BARE_METALHOU02Xeon_2690LargeCentral US (Houston 02)
SOFTLAYER_BARE_METALHOU02Xeon_2690_x2Extra LargeCentral US (Houston 02)
SOFTLAYER_BARE_METALLON02Xeon_1270MediumWestern Europe (London 02)
SOFTLAYER_BARE_METALLON02Xeon_2690LargeWestern Europe (London 02)
SOFTLAYER_BARE_METALLON02Xeon_2690_x2Extra LargeWestern Europe (London 02)
SOFTLAYER_BARE_METALMEL01Xeon_1270MediumAustralia (Melbourne 01)
SOFTLAYER_BARE_METALMEL01Xeon_2690LargeAustralia (Melbourne 01)
SOFTLAYER_BARE_METALMEL01Xeon_2690_x2Extra LargeAustralia (Melbourne 01)
SOFTLAYER_BARE_METALMEX01Xeon_1270MediumMexico (Queretaro 01)
SOFTLAYER_BARE_METALMEX01Xeon_2690LargeMexico (Queretaro 01)
SOFTLAYER_BARE_METALMEX01Xeon_2690_x2Extra LargeMexico (Queretaro 01)
SOFTLAYER_BARE_METALMON01Xeon_1270MediumCanada (Montreal 01)
SOFTLAYER_BARE_METALMON01Xeon_2690LargeCanada (Montreal 01)
SOFTLAYER_BARE_METALMON01Xeon_2690_x2Extra LargeCanada (Montreal 01)
SOFTLAYER_BARE_METALPAR01Xeon_1270MediumWestern Europe (Paris 01)
SOFTLAYER_BARE_METALPAR01Xeon_2690LargeWestern Europe (Paris 01)
SOFTLAYER_BARE_METALPAR01Xeon_2690_x2Extra LargeWestern Europe (Paris 01)
SOFTLAYER_BARE_METALSEA01Xeon_1270MediumWest Coast US (Seattle 01)
SOFTLAYER_BARE_METALSEA01Xeon_2690LargeWest Coast US (Seattle 01)
SOFTLAYER_BARE_METALSEA01Xeon_2690_x2Extra LargeWest Coast US (Seattle 01)
SOFTLAYER_BARE_METALSJC01Xeon_1270MediumWest Coast US (San Jose 01)
SOFTLAYER_BARE_METALSJC01Xeon_2690LargeWest Coast US (San Jose 01)
SOFTLAYER_BARE_METALSJC01Xeon_2690_x2Extra LargeWest Coast US (San Jose 01)
SOFTLAYER_BARE_METALSNG01Xeon_1270MediumSoutheast Asia (Singapore 01)
SOFTLAYER_BARE_METALSNG01Xeon_2690LargeSoutheast Asia (Singapore 01)
SOFTLAYER_BARE_METALSNG01Xeon_2690_x2Extra LargeSoutheast Asia (Singapore 01)
SOFTLAYER_BARE_METALSYD01Xeon_1270MediumAustralia (Sydney 01)
SOFTLAYER_BARE_METALSYD01Xeon_2690LargeAustralia (Sydney 01)
SOFTLAYER_BARE_METALSYD01Xeon_2690_x2Extra LargeAustralia (Sydney 01)
SOFTLAYER_BARE_METALTOK02Xeon_1270MediumJapan (Tokyo 02)
SOFTLAYER_BARE_METALTOK02Xeon_2690LargeJapan (Tokyo 02)
SOFTLAYER_BARE_METALTOK02Xeon_2690_x2Extra LargeJapan (Tokyo 02)
SOFTLAYER_BARE_METALTOR01Xeon_1270MediumCanada (Toronto 01)
SOFTLAYER_BARE_METALTOR01Xeon_2690LargeCanada (Toronto 01)
SOFTLAYER_BARE_METALTOR01Xeon_2690_x2Extra LargeCanada (Toronto 01)
SOFTLAYER_BARE_METALWDC01Xeon_1270MediumEast Coast US (Washington, DC 01)
SOFTLAYER_BARE_METALWDC01Xeon_2690LargeEast Coast US (Washington, DC 01)
SOFTLAYER_BARE_METALWDC01Xeon_2690_x2Extra LargeEast Coast US (Washington, DC 01)
GCPasia-east1n1-highmem-4-1600High Memory: BulkEastern Asia-Pacific (Taiwan)
GCPasia-east1n1-highmem-4-400High Memory: SmallEastern Asia-Pacific (Taiwan)
GCPasia-east1n1-highmem-4-800High Memory: BalancedEastern Asia-Pacific (Taiwan)
GCPasia-east1n1-standard-1ProfessionalEastern Asia-Pacific (Taiwan)
GCPasia-east1n1-standard-2TinyEastern Asia-Pacific (Taiwan)
GCPasia-east1n1-standard-4-1600BulkEastern Asia-Pacific (Taiwan)
GCPasia-east1n1-standard-4-400SmallEastern Asia-Pacific (Taiwan)
GCPasia-east1n1-standard-4-800BalancedEastern Asia-Pacific (Taiwan)
GCPasia-northeast1n1-highmem-4-1600High Memory: BulkNortheastern Asia-pacific (Japan)
GCPasia-northeast1n1-highmem-4-400High Memory: SmallNortheastern Asia-pacific (Japan)
GCPasia-northeast1n1-highmem-4-800High Memory: BalancedNortheastern Asia-pacific (Japan)
GCPasia-northeast1n1-standard-1ProfessionalNortheastern Asia-pacific (Japan)
GCPasia-northeast1n1-standard-2TinyNortheastern Asia-pacific (Japan)
GCPasia-northeast1n1-standard-4-1600BulkNortheastern Asia-pacific (Japan)
GCPasia-northeast1n1-standard-4-400SmallNortheastern Asia-pacific (Japan)
GCPasia-northeast1n1-standard-4-800BalancedNortheastern Asia-pacific (Japan)
GCPeurope-west1n1-highmem-4-1600High Memory: BulkWestern Europe (Belgium)
GCPeurope-west1n1-highmem-4-400High Memory: SmallWestern Europe (Belgium)
GCPeurope-west1n1-highmem-4-800High Memory: BalancedWestern Europe (Belgium)
GCPeurope-west1n1-standard-1ProfessionalWestern Europe (Belgium)
GCPeurope-west1n1-standard-2TinyWestern Europe (Belgium)
GCPeurope-west1n1-standard-4-1600BulkWestern Europe (Belgium)
GCPeurope-west1n1-standard-4-400SmallWestern Europe (Belgium)
GCPeurope-west1n1-standard-4-800BalancedWestern Europe (Belgium)
GCPus-central1n1-highmem-4-1600High Memory: BulkCentral US (Iowa)
GCPus-central1n1-highmem-4-400High Memory: SmallCentral US (Iowa)
GCPus-central1n1-highmem-4-800High Memory: BalancedCentral US (Iowa)
GCPus-central1n1-standard-1ProfessionalCentral US (Iowa)
GCPus-central1n1-standard-2TinyCentral US (Iowa)
GCPus-central1n1-standard-4-1600BulkCentral US (Iowa)
GCPus-central1n1-standard-4-400SmallCentral US (Iowa)
GCPus-central1n1-standard-4-800BalancedCentral US (Iowa)
GCPus-east1n1-highmem-4-1600High Memory: BulkEastern US (South Carolina)
GCPus-east1n1-highmem-4-400High Memory: SmallEastern US (South Carolina)
GCPus-east1n1-highmem-4-800High Memory: BalancedEastern US (South Carolina)
GCPus-east1n1-standard-1ProfessionalEastern US (South Carolina)
GCPus-east1n1-standard-2TinyEastern US (South Carolina)
GCPus-east1n1-standard-4-1600BulkEastern US (South Carolina)
GCPus-east1n1-standard-4-400SmallEastern US (South Carolina)
GCPus-east1n1-standard-4-800BalancedEastern US (South Carolina)
GCPus-west1n1-highmem-4-1600High Memory: BulkWestern US (Oregon)
GCPus-west1n1-highmem-4-400High Memory: SmallWestern US (Oregon)
GCPus-west1n1-highmem-4-800High Memory: BalancedWestern US (Oregon)
GCPus-west1n1-standard-1ProfessionalWestern US (Oregon)
GCPus-west1n1-standard-2TinyWestern US (Oregon)
GCPus-west1n1-standard-4-1600BulkWestern US (Oregon)
GCPus-west1n1-standard-4-400SmallWestern US (Oregon)
GCPus-west1n1-standard-4-800BalancedWestern US (Oregon)

Note: These values can change over time. If in doubt see the create cluster page on the console or contact support.

Reference Data - Racks

We recommend that rack allocation be distributed evenly where possible to ensure consistent performance and optimal data distribution & redundancy.

providerdataCentrerackAllocation.name
AWS_VPCAP_NORTHEAST_1ap-northeast-1a
AWS_VPCAP_NORTHEAST_1ap-northeast-1c
AWS_VPCAP_SOUTHEAST_1ap-southeast-1a
AWS_VPCAP_SOUTHEAST_1ap-southeast-1b
AWS_VPCAP_SOUTHEAST_2ap-southeast-2a
AWS_VPCAP_SOUTHEAST_2ap-southeast-2b
AWS_VPCEU_CENTRAL_1eu-central-1a
AWS_VPCEU_CENTRAL_1eu-central-1b
AWS_VPCEU_WEST_1eu-west-1a
AWS_VPCEU_WEST_1eu-west-1b
AWS_VPCEU_WEST_1eu-west-1c
AWS_VPCSA_EAST_1sa-east-1a
AWS_VPCSA_EAST_1sa-east-1c
AWS_VPCUS_EAST_1us-east-1a
AWS_VPCUS_EAST_1us-east-1b
AWS_VPCUS_EAST_1us-east-1c
AWS_VPCUS_EAST_1us-east-1d
AWS_VPCUS_EAST_1us-east-1e
AWS_VPCUS_WEST_1us-west-1b
AWS_VPCUS_WEST_1us-west-1c
AWS_VPCUS_WEST_2us-west-2a
AWS_VPCUS_WEST_2us-west-2b
AWS_VPCUS_WEST_2us-west-2c
AZUREAUSTRALIA_SOUTHEASTfault-domain-0
AZUREAUSTRALIA_SOUTHEASTfault-domain-1
AZUREAUSTRALIA_SOUTHEASTfault-domain-2
AZURECANADA_CENTRALfault-domain-0
AZURECANADA_CENTRALfault-domain-1
AZURECANADA_CENTRALfault-domain-2
AZURECANADA_EASTfault-domain-0
AZURECANADA_EASTfault-domain-1
AZURECANADA_EASTfault-domain-2
AZURECENTRAL_USfault-domain-0
AZURECENTRAL_USfault-domain-1
AZURECENTRAL_USfault-domain-2
AZUREEAST_ASIAfault-domain-0
AZUREEAST_ASIAfault-domain-1
AZUREEAST_ASIAfault-domain-2
AZUREEAST_USfault-domain-0
AZUREEAST_USfault-domain-1
AZUREEAST_USfault-domain-2
AZUREEAST_US_2fault-domain-0
AZUREEAST_US_2fault-domain-1
AZUREEAST_US_2fault-domain-2
AZUREJAPAN_EASTfault-domain-0
AZUREJAPAN_EASTfault-domain-1
AZUREJAPAN_EASTfault-domain-2
AZUREJAPAN_WESTfault-domain-0
AZUREJAPAN_WESTfault-domain-1
AZUREJAPAN_WESTfault-domain-2
AZURENORTH_EUROPEfault-domain-0
AZURENORTH_EUROPEfault-domain-1
AZURENORTH_EUROPEfault-domain-2
AZURESOUTH_CENTRAL_USfault-domain-0
AZURESOUTH_CENTRAL_USfault-domain-1
AZURESOUTH_CENTRAL_USfault-domain-2
AZURESOUTHEAST_ASIAfault-domain-0
AZURESOUTHEAST_ASIAfault-domain-1
AZURESOUTHEAST_ASIAfault-domain-2
AZUREWEST_EUROPEfault-domain-0
AZUREWEST_EUROPEfault-domain-1
AZUREWEST_EUROPEfault-domain-2
AZUREWEST_USfault-domain-0
AZUREWEST_USfault-domain-1
AZUREWEST_USfault-domain-2
SOFTLAYER_BARE_METALAMS01AMS01
SOFTLAYER_BARE_METALAMS03AMS03
SOFTLAYER_BARE_METALDAL01DAL01
SOFTLAYER_BARE_METALDAL05DAL05
SOFTLAYER_BARE_METALDAL06DAL06
SOFTLAYER_BARE_METALDAL07DAL07
SOFTLAYER_BARE_METALDAL09DAL09
SOFTLAYER_BARE_METALFRA02FRA02
SOFTLAYER_BARE_METALHKG02HKG02
SOFTLAYER_BARE_METALHOU02HOU02
SOFTLAYER_BARE_METALLON02LON02
SOFTLAYER_BARE_METALMEL01MEL01
SOFTLAYER_BARE_METALMEX01MEX01
SOFTLAYER_BARE_METALMON01MON01
SOFTLAYER_BARE_METALPAR01PAR01
SOFTLAYER_BARE_METALSEA01SEA01
SOFTLAYER_BARE_METALSJC01SJC01
SOFTLAYER_BARE_METALSNG01SNG01
SOFTLAYER_BARE_METALSYD01SYD01
SOFTLAYER_BARE_METALTOK02TOK02
SOFTLAYER_BARE_METALTOR01TOR01
SOFTLAYER_BARE_METALWDC01WDC01
GCPus-west1us-west1-a
GCPus-west1us-west1-b
GCPus-central1us-central1-a
GCPus-central1us-central1-b
GCPus-central1us-central1-c
GCPus-central1us-central1-f
GCPus-east1us-east1-b
GCPus-east1us-east1-c
GCPus-east1us-east1-d
GCPeurope-west1europe-west1-b
GCPeurope-west1europe-west1-c
GCPeurope-west1europe-west1-d
GCPasia-east1asia-east1-a
GCPasia-east1asia-east1-b
GCPasia-east1asia-east1-c
GCPasia-northeast1asia-northeast1-a
GCPasia-northeast1asia-northeast1-b
GCPasia-northeast1asia-northeast1-c

Customers running in their own accounts may have other racks available for provisioning.

Errors

Unsuccessful calls will return the following responses, depending upon the issue. Where possible we will provide meaningful detail on the failure:

  • 400 Bad Request: Returned when the expected node or cluster ID is not a valid UUID.
  • 404 Not Found: Returned when accessing an incorrect URL or trying to access a cluster/node not owned by the authenticated user.
  • 415 Unsupported Media Type: Returned when the payload is in an unsupported format. Possibly resolved by specifying content-type as application/json.
  • 429 Too Many Requests: Returned when the request rate exceeds 1 request / 2.5 seconds.
  • 500 Server Error: All other errors.

Backups / Restores

List Backups

To list active and completed backups for each node in the cluster, for the last 7 days, make a GET request to https://api.instaclustr.com/provisioning/v1/<clusterId>/backups

The response will contain an array of backups per node:

Trigger Backup

To immediately trigger a cluster-wide backup on each node, make a POST request to https://api.instaclustr.com/provisioning/v1/<clusterId>/backups

If the request was received successfully, a 204 status code response will be returned.

To monitor the status of the backups, query the “List Backups” endpoint.

 

Please note that all nodes will simultaneously flush their memtables to disk and may have a brief performance impact.

 

Trigger Restore

Cluster backups may be used to restore data from a point-in-time to a new cluster.  Data will be restored to a new cluster.

 

When restoring a cluster, you may choose to:

  • Restore all data or only selected tables: If restoring a subset of tables, the cluster schema will still be restored in its entirety and therefore the schemas for any non-restored keyspaces and tables will still be applied.  However, only backup data for the selected tables will be restored.
  • Restore to a point-in-time: The restore process will use the latest backup data for each node, up to the specified point-in-time.  If restoring a cluster with Continuous Backup enabled, then commit logs will also be restored.

 

Once the Restore parameters are submitted, a new cluster will be provisioned under the account with a topology matching the designated point-in-time (e.g. if 3 nodes were added to a 3-node cluster on 01/10/2017 and the restore operation was for a point-in-time of 30/09/2017, then the restored cluster will have 3 nodes).

 

To trigger a restore, make a POST request to https://api.instaclustr.com/provisioning/v1/<clusterId>/backups/restore

 

The request may:

  • Be empty: Triggers a restore to the current date and time, using the most recent backup for each node and a cluster name marked as “restored” and containing the timestamp when the restore was requested.

Or

FieldAllowed ValuesDefault value
pointInTimeString

Specify a date and time: The date and time to restore to must be in milliseconds since epoch.
All backed up data will be restored, for this point in time.

Current Date & time
keyspaceTablesSpecify a keyspace/table string and date and time

The keyspace/table string must be comma-separated and in the format <keyspace>.<table1>,<keyspace>.<table2>.

Only data for the specified tables will be restored, for the point in time.

 

clusterNameOverrideThe display name of the cluster on the Instaclustr Console and Provisioning Api.

By default, we will create the restored cluster with its current name, but appended with “restored” and the date & time it was requested to be restored.

clustername-restored-(datetime)

 

For example:

FREE TRIAL

Spin up a cluster in less
than 5 minutes.
(No credit card required)

Sign Up Now
Close

Site by Swell Design Group