Provisioning API with GCP

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 processed 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 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.

Authentication

All requests to the API must use Basic Authentication and contain a valid username and API key.

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

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

{
    "clusterName":"CassandraCluster",
    "provider":"AWS_VPC",
    "account": "YourAccount",
    "version":"apache-cassandra-2.1.13",
    "size":"t2.small",
    "region": {
        "dataCentre":"US_WEST_2",
        "authnAuthz":"true",
        "clientEncryption": "false",
        "usePrivateBroadcastRPCAddress":"true",
        "defaultNetwork":"",
        "firewallRules":[],
        "rackAllocation":[
            {
                "name":"us-west-2a", "nodeCount":"2"
            },
            {
                "name":"us-west-2b", "nodeCount":"2"
            },
            {
                "name":"us-west-2c", "nodeCount":"2"
            }
    ]}
}

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

{
    "clusterName":"CassandraCluster",
    "provider":"AWS_VPC",
    ...
    "region": {
        ...
        "firewallRules":[],
        "diskEncryptionKey":"UUID returned after adding a KMS key",
        "rackAllocation":[...]
    }
}

If the JSON is valid (see allowed values below), we 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 useable 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

Field

Allowed Values

cluster_name

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 'Create Cluster' page 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.data_centre

See 'Data centres and node sizes' reference table below

region.client_encryption

MUST be false on developer (t2) nodes

region.default_network

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

region.firewall_rules

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

region.rack_allocation

See 'Racks' reference table below

Cluster Status

GET request to https://api.instaclustr.com/provisioning/v1/<clusterId>

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

{  
   "id":"77b5a4e1-c422-4a78-b551-d8fa5c42ad95",
   "clusterName":"MyInstaclustr",
   "clusterNetwork":"{"network":"10.224.0.0","prefixLength":12}",
   "clusterStatus":"RUNNING",
   "cassandraVersion":"apache-cassandra-2.1.11",
   "username":"iccassandra",
   "instaclustrUserPassword":"supersecretpassword",
   "clusterCertificateDownload":"disabled",
   "dataCentres":[  
      {  
         "id":"f0bdb45c-f83c-4298-aa38-4d5a779ba816",
         "name":"US_EAST_1",
         "provider":"AWS_VPC",
         "clientEncryption":false,
         "passwordAuthentication":true,
         "userAuthorization":true,
         "usePrivateBroadcastRPCAddress":true,
         "cdcNetwork":{"network":"10.224.0.0","prefixLength":16},"bundles":["SPARK"]
         "nodes":[  
            {  
               "id":"cb986e08-f6be-4d08-8de2-4352c2cfaf1f",
               "size":"t2.small",
               "rack":"us-east-1a",
               "publicAddress":"111.111.111.111",
               "privateAddress":"111.111.111.111",
               "nodeStatus":"RUNNING"
               "sparkMaster":true,
               "sparkJobserver":true,
               "zeppelin":false
            },
            {  
               "id":"f1809b07-ed42-4c40-83e0-e7cf8358a9cf",
               "size":"t2.small",
               "rack":"us-east-1e",
               "publicAddress":"111.111.111.111",
               "privateAddress":"111.111.111.111",
               "nodeStatus":"RUNNING"
               "sparkMaster":true,
               "sparkJobserver":false,
               "zeppelin":false
            },
            {  
               "id":"c8c29c26-91b4-4878-b11a-953a0b70c422",
               "size":"t2.small",
               "rack":"us-east-1d",
               "publicAddress":"111.111.111.111",
               "privateAddress":"111.111.111.111",
               "nodeStatus":"RUNNING"
               "sparkMaster":true,
               "sparkJobserver":false,
               "zeppelin":false
            }
         ]
      "nodeCount":3
      }]
}

Delete 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: 

[ 
   { 
      "id":"77b5a4e1-c422-4a78-b551-d8fa5c42ad95",
      "name":"myInstaclustr",
      "cassandraVersion":"apache-cassandra-2.1.11",
      "nodeCount":4,
      "runningNodeCount":3,
      "derivedStatus":"RUNNING"
   }
]

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:

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

If the JSON is valid (see allowed values below), we 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. If you have recently deleted a firewall rule, you may need to wait up to 10 minutes before provisioning a replacement using the same network.

Allowed Values

Field

Allowed Values

network

Must be a valid IPv4 CIDR.

type

CASSANDRA, SPARK, SPARK_JOBSERVER

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:

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

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

It can take up to 10 minutes for the firewall rule to be deleted. You can check the status of provisioning using the list firewall rules endpoint, or via the console. If you have recently deleted a firewall rule, you may need to wait up to 10 minutes before provisioning a replacement using the same network.

Allowed Values

Field

Allowed 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 GET request to https://api.instaclustr.com/provisioning/v1/vpc-peering/<clusterDataCentreId>

The response will contain an array of VPC Peering Connections:

[
      {
      "id": "068c447e-8475-49b2-974b-ca1c917012324",
      "aws_vpc_connection_id": "pcx-a667dbcf",
      "clusterDataCentre": "a008665c-8916-1234-978c-90d49a3a1364",
      "vpcId": "vpc-002512aa",
      "peerVpcId": "vpc-a5bacd45",
      "peerAccountId": "123777123999",
      "peerSubnet":       {
         "network": "10.7.0.0",
         "prefixLength": 16
      },
      "statusCode": "active"
   },
      {
      "id": "561f463e-522e-4a5f-968e-e65961b6d9aa",
      "aws_vpc_connection_id": "pcx-8667dbef",
      "clusterDataCentre": "a008665c-8916-40ae-978c-90d49a3a1364",
      "vpcId": "vpc-00250e64",
      "peerVpcId": "vpc-c2f6d4a6",
      "peerAccountId": "123555127866",
      "peerSubnet":       {
         "network": "10.99.0.0",
         "prefixLength": 16
      },
      "statusCode": "pending-acceptance"
   }
]

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:

{
   "id": "068c447e-9999-49b2-a74b-ca1c91702999",
   "aws_vpc_connection_id": "pcx-ff12abc1",
   "clusterDataCentre": "aabc665c-8916-40ae-978c-96d39a3a1364",
   "vpcId": "vpc-aa770abc",
   "peerVpcId": "vpc-aabb1122",
   "peerAccountId": "123888456789",
   "peerSubnet":    {
      "network": "10.7.0.0",
      "prefixLength": 16
   },
   "statusCode": "active"
}

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 like:

{
	"peerVpcId" : "vpc-aaaa1234",
	"peerAccountId" : "123770124789",
	"peerSubnet" : "10.7.0.0/16"
}

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

{"id": "068c447e-8475-49b2-974b-ca1c91702ed4"}

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

provider data_centre size Plan Data Centre Name
AWS_VPC AP_NORTHEAST_1 m4l-250 EBS: tiny Asia Pacific (Tokyo)
AWS_VPC AP_NORTHEAST_1 m4xl-400 EBS: small Asia Pacific (Tokyo)
AWS_VPC AP_NORTHEAST_1 m4xl-800 EBS: balanced Asia Pacific (Tokyo)
AWS_VPC AP_NORTHEAST_1 m4xl-1600 EBS: bulk storage Asia Pacific (Tokyo)
AWS_VPC AP_NORTHEAST_1 m3.xlarge Small Asia Pacific (Tokyo)
AWS_VPC AP_NORTHEAST_1 c3.2xlarge Medium Asia Pacific (Tokyo)
AWS_VPC AP_NORTHEAST_1 i2.2xlarge Extra Large Asia Pacific (Tokyo)
AWS_VPC AP_NORTHEAST_1 t2.small Starter Asia Pacific (Tokyo)
AWS_VPC AP_NORTHEAST_1 t2.medium Professional Asia Pacific (Tokyo)
AWS_VPC AP_SOUTHEAST_1 m4l-250 EBS: tiny Asia Pacific (Singapore)
AWS_VPC AP_SOUTHEAST_1 m4xl-400 EBS: small Asia Pacific (Singapore)
AWS_VPC AP_SOUTHEAST_1 m4xl-800 EBS: balanced Asia Pacific (Singapore)
AWS_VPC AP_SOUTHEAST_1 m4xl-1600 EBS: bulk storage Asia Pacific (Singapore)
AWS_VPC AP_SOUTHEAST_1 m3.xlarge Small Asia Pacific (Singapore)
AWS_VPC AP_SOUTHEAST_1 c3.2xlarge Medium Asia Pacific (Singapore)
AWS_VPC AP_SOUTHEAST_1 i2.2xlarge Extra Large Asia Pacific (Singapore)
AWS_VPC AP_SOUTHEAST_1 t2.small Starter Asia Pacific (Singapore)
AWS_VPC AP_SOUTHEAST_1 t2.medium Professional Asia Pacific (Singapore)
AWS_VPC AP_SOUTHEAST_2 m4l-250 EBS: tiny Asia Pacific (Sydney)
AWS_VPC AP_SOUTHEAST_2 m4xl-400 EBS: small Asia Pacific (Sydney)
AWS_VPC AP_SOUTHEAST_2 m4xl-800 EBS: balanced Asia Pacific (Sydney)
AWS_VPC AP_SOUTHEAST_2 m4xl-1600 EBS: bulk storage Asia Pacific (Sydney)
AWS_VPC AP_SOUTHEAST_2 m3.xlarge Small Asia Pacific (Sydney)
AWS_VPC AP_SOUTHEAST_2 c3.2xlarge Medium Asia Pacific (Sydney)
AWS_VPC AP_SOUTHEAST_2 i2.2xlarge Extra Large Asia Pacific (Sydney)
AWS_VPC AP_SOUTHEAST_2 t2.small Starter Asia Pacific (Sydney)
AWS_VPC AP_SOUTHEAST_2 t2.medium Professional Asia Pacific (Sydney)
AWS_VPC EU_CENTRAL_1 m4l-250 EBS: tiny EU Central (Frankfurt)
AWS_VPC EU_CENTRAL_1 t2.small Starter EU Central (Frankfurt)
AWS_VPC EU_CENTRAL_1 t2.medium Professional EU Central (Frankfurt)
AWS_VPC EU_CENTRAL_1 m3.xlarge Small EU Central (Frankfurt)
AWS_VPC EU_CENTRAL_1 c3.2xlarge Medium EU Central (Frankfurt)
AWS_VPC EU_CENTRAL_1 i2.2xlarge Extra Large EU Central (Frankfurt)
AWS_VPC EU_CENTRAL_1 m4xl-400 EBS: small EU Central (Frankfurt)
AWS_VPC EU_CENTRAL_1 m4xl-800 EBS: balanced EU Central (Frankfurt)
AWS_VPC EU_CENTRAL_1 m4xl-1600 EBS: bulk storage EU Central (Frankfurt)
AWS_VPC EU_WEST_1 m4l-250 EBS: tiny EU West (Ireland)
AWS_VPC EU_WEST_1 m4xl-400 EBS: small EU West (Ireland)
AWS_VPC EU_WEST_1 m4xl-800 EBS: balanced EU West (Ireland)
AWS_VPC EU_WEST_1 m4xl-1600 EBS: bulk storage EU West (Ireland)
AWS_VPC EU_WEST_1 m3.xlarge Small EU West (Ireland)
AWS_VPC EU_WEST_1 c3.2xlarge Medium EU West (Ireland)
AWS_VPC EU_WEST_1 i2.2xlarge Extra Large EU West (Ireland)
AWS_VPC EU_WEST_1 t2.small Starter EU West (Ireland)
AWS_VPC EU_WEST_1 t2.medium Professional EU West (Ireland)
AWS_VPC EU_WEST_1 m42xl-1600 Special Size: m4.2xlarge EU West (Ireland)
AWS_VPC SA_EAST_1 m3.xlarge Small South America (São Paulo)
AWS_VPC SA_EAST_1 c3.2xlarge Medium South America (São Paulo)
AWS_VPC SA_EAST_1 t2.small Starter South America (São Paulo)
AWS_VPC SA_EAST_1 t2.medium Professional South America (São Paulo)
AWS_VPC US_EAST_1 m4l-250 EBS: tiny US East (Northern Virginia)
AWS_VPC US_EAST_1 m4xl-400 EBS: small US East (Northern Virginia)
AWS_VPC US_EAST_1 m4xl-800 EBS: balanced US East (Northern Virginia)
AWS_VPC US_EAST_1 m4xl-1600 EBS: bulk storage US East (Northern Virginia)
AWS_VPC US_EAST_1 m3.xlarge Small US East (Northern Virginia)
AWS_VPC US_EAST_1 c3.2xlarge Medium US East (Northern Virginia)
AWS_VPC US_EAST_1 i2.2xlarge Extra Large US East (Northern Virginia)
AWS_VPC US_EAST_1 t2.small Starter US East (Northern Virginia)
AWS_VPC US_EAST_1 t2.medium Professional US East (Northern Virginia)
AWS_VPC US_EAST_1 m42xl-1600 Special Size: m4.2xlarge US East (Northern Virginia)
AWS_VPC US_WEST_1 m4l-250 EBS: tiny US West (Northern California)
AWS_VPC US_WEST_1 m4xl-400 EBS: small US West (Northern California)
AWS_VPC US_WEST_1 m4xl-800 EBS: balanced US West (Northern California)
AWS_VPC US_WEST_1 m4xl-1600 EBS: bulk storage US West (Northern California)
AWS_VPC US_WEST_1 m3.xlarge Small US West (Northern California)
AWS_VPC US_WEST_1 c3.2xlarge Medium US West (Northern California)
AWS_VPC US_WEST_1 i2.2xlarge Extra Large US West (Northern California)
AWS_VPC US_WEST_1 t2.small Starter US West (Northern California)
AWS_VPC US_WEST_1 t2.medium Professional US West (Northern California)
AWS_VPC US_WEST_2 m4l-250 EBS: tiny US West (Oregon)
AWS_VPC US_WEST_2 m4xl-400 EBS: small US West (Oregon)
AWS_VPC US_WEST_2 m4xl-800 EBS: balanced US West (Oregon)
AWS_VPC US_WEST_2 m4xl-1600 EBS: bulk storage US West (Oregon)
AWS_VPC US_WEST_2 m3.xlarge Small US West (Oregon)
AWS_VPC US_WEST_2 c3.2xlarge Medium US West (Oregon)
AWS_VPC US_WEST_2 i2.2xlarge Extra Large US West (Oregon)
AWS_VPC US_WEST_2 t2.small Starter US West (Oregon)
AWS_VPC US_WEST_2 t2.medium Professional US West (Oregon)
AZURE CANADA_CENTRAL Standard_DS12_v2-512 Premium: small Canada Central (Toronto)
AZURE CANADA_CENTRAL Standard_DS12_v2-1023 Premium: balanced Canada Central (Toronto)
AZURE CANADA_CENTRAL Standard_DS12_v2-2046 Premium: bulk storage Canada Central (Toronto)
AZURE CANADA_CENTRAL Standard_DS2_v2-256 Premium: tiny Canada Central (Toronto)
AZURE CANADA_EAST Standard_DS12_v2-512 Premium: small Canada East (Quebec City)
AZURE CANADA_EAST Standard_DS12_v2-1023 Premium: balanced Canada East (Quebec City)
AZURE CANADA_EAST Standard_DS12_v2-2046 Premium: bulk storage Canada East (Quebec City)
AZURE CANADA_EAST Standard_DS2_v2-256 Premium: tiny Canada East (Quebec City)
AZURE CENTRAL_US Standard_DS12_v2-512 Premium: small Central US (Iowa)
AZURE CENTRAL_US Standard_DS12_v2-1023 Premium: balanced Central US (Iowa)
AZURE CENTRAL_US Standard_DS12_v2-2046 Premium: bulk storage Central US (Iowa)
AZURE CENTRAL_US Standard_DS2_v2-256 Premium: tiny Central US (Iowa)
AZURE CENTRAL_US Standard_DS13_v2-2046 Premium: extra large Central US (Iowa)
AZURE EAST_ASIA Standard_DS12-512 Premium: small East Asia (Hong Kong)
AZURE EAST_ASIA Standard_DS12-1023 Premium: balanced East Asia (Hong Kong)
AZURE EAST_ASIA Standard_DS12-2046 Premium: bulk storage East Asia (Hong Kong)
AZURE EAST_ASIA Standard_DS2-256 Premium: tiny East Asia (Hong Kong)
AZURE EAST_US Standard_DS12_v2-512 Premium: small East US (Virginia)
AZURE EAST_US Standard_DS12_v2-1023 Premium: balanced East US (Virginia)
AZURE EAST_US Standard_DS12_v2-2046 Premium: bulk storage East US (Virginia)
AZURE EAST_US Standard_DS2_v2-256 Premium: tiny East US (Virginia)
AZURE EAST_US_2 Standard_DS12_v2-512 Premium: small East US 2 (Virginia)
AZURE EAST_US_2 Standard_DS12_v2-1023 Premium: balanced East US 2 (Virginia)
AZURE EAST_US_2 Standard_DS12_v2-2046 Premium: bulk storage East US 2 (Virginia)
AZURE EAST_US_2 Standard_DS2_v2-256 Premium: tiny East US 2 (Virginia)
AZURE JAPAN_WEST Standard_DS12_v2-512 Premium: small Japan West (Osaka Prefecture)
AZURE JAPAN_WEST Standard_DS12_v2-1023 Premium: balanced Japan West (Osaka Prefecture)
AZURE JAPAN_WEST Standard_DS12_v2-2046 Premium: bulk storage Japan West (Osaka Prefecture)
AZURE JAPAN_WEST Standard_DS2_v2-256 Premium: tiny Japan West (Osaka Prefecture)
AZURE NORTH_EUROPE Standard_DS12_v2-512 Premium: small North Europe (Ireland)
AZURE NORTH_EUROPE Standard_DS12_v2-1023 Premium: balanced North Europe (Ireland)
AZURE NORTH_EUROPE Standard_DS12_v2-2046 Premium: bulk storage North Europe (Ireland)
AZURE NORTH_EUROPE Standard_DS2_v2-256 Premium: tiny North Europe (Ireland)
AZURE SOUTH_CENTRAL_US Standard_DS12_v2-512 Premium: small South Central US (Texas)
AZURE SOUTH_CENTRAL_US Standard_DS12_v2-1023 Premium: balanced South Central US (Texas)
AZURE SOUTH_CENTRAL_US Standard_DS12_v2-2046 Premium: bulk storage South Central US (Texas)
AZURE SOUTH_CENTRAL_US Standard_DS2_v2-256 Premium: tiny South Central US (Texas)
AZURE SOUTHEAST_ASIA Standard_DS12_v2-512 Premium: small Southeast Asia (Singapore)
AZURE SOUTHEAST_ASIA Standard_DS12_v2-1023 Premium: balanced Southeast Asia (Singapore)
AZURE SOUTHEAST_ASIA Standard_DS12_v2-2046 Premium: bulk storage Southeast Asia (Singapore)
AZURE SOUTHEAST_ASIA Standard_DS2_v2-256 Premium: tiny Southeast Asia (Singapore)
AZURE SOUTHEAST_ASIA Standard_DS13_v2-2046 Premium: extra large Southeast Asia (Singapore)
AZURE WEST_EUROPE Standard_DS12_v2-512 Premium: small West Europe (Netherlands)
AZURE WEST_EUROPE Standard_DS12_v2-1023 Premium: balanced West Europe (Netherlands)
AZURE WEST_EUROPE Standard_DS12_v2-2046 Premium: bulk storage West Europe (Netherlands)
AZURE WEST_EUROPE Standard_DS2_v2-256 Premium: tiny West Europe (Netherlands)
AZURE WEST_US Standard_DS12_v2-512 Premium: small West US (California)
AZURE WEST_US Standard_DS12_v2-1023 Premium: balanced West US (California)
AZURE WEST_US Standard_DS12_v2-2046 Premium: bulk storage West US (California)
AZURE WEST_US Standard_DS2_v2-256 Premium: tiny West US (California)
SOFTLAYER_BARE_METAL AMS01 Xeon_1270 Medium Western Europe (Amsterdam 01)
SOFTLAYER_BARE_METAL AMS01 Xeon_2690 Large Western Europe (Amsterdam 01)
SOFTLAYER_BARE_METAL AMS01 Xeon_2690_x2 Extra Large Western Europe (Amsterdam 01)
SOFTLAYER_BARE_METAL AMS03 Xeon_1270 Medium Western Europe (Amsterdam 03)
SOFTLAYER_BARE_METAL AMS03 Xeon_2690 Large Western Europe (Amsterdam 03)
SOFTLAYER_BARE_METAL AMS03 Xeon_2690_x2 Extra Large Western Europe (Amsterdam 03)
SOFTLAYER_BARE_METAL DAL01 Xeon_1270 Medium Central US (Dallas 01)
SOFTLAYER_BARE_METAL DAL01 Xeon_2690 Large Central US (Dallas 01)
SOFTLAYER_BARE_METAL DAL01 Xeon_2690_x2 Extra Large Central US (Dallas 01)
SOFTLAYER_BARE_METAL DAL05 Xeon_1270 Medium Central US (Dallas 05)
SOFTLAYER_BARE_METAL DAL05 Xeon_2690 Large Central US (Dallas 05)
SOFTLAYER_BARE_METAL DAL05 Xeon_2690_x2 Extra Large Central US (Dallas 05)
SOFTLAYER_BARE_METAL DAL06 Xeon_1270 Medium Central US (Dallas 06)
SOFTLAYER_BARE_METAL DAL06 Xeon_2690 Large Central US (Dallas 06)
SOFTLAYER_BARE_METAL DAL06 Xeon_2690_x2 Extra Large Central US (Dallas 06)
SOFTLAYER_BARE_METAL DAL07 Xeon_1270 Medium Central US (Dallas 07)
SOFTLAYER_BARE_METAL DAL07 Xeon_2690 Large Central US (Dallas 07)
SOFTLAYER_BARE_METAL DAL07 Xeon_2690_x2 Extra Large Central US (Dallas 07)
SOFTLAYER_BARE_METAL DAL09 Xeon_1270 Medium Central US (Dallas 09)
SOFTLAYER_BARE_METAL DAL09 Xeon_2690 Large Central US (Dallas 09)
SOFTLAYER_BARE_METAL DAL09 Xeon_2690_x2 Extra Large Central US (Dallas 09)
SOFTLAYER_BARE_METAL FRA02 Xeon_1270 Medium Western Europe (Frankfurt 02)
SOFTLAYER_BARE_METAL FRA02 Xeon_2690 Large Western Europe (Frankfurt 02)
SOFTLAYER_BARE_METAL FRA02 Xeon_2690_x2 Extra Large Western Europe (Frankfurt 02)
SOFTLAYER_BARE_METAL HKG02 Xeon_1270 Medium Asia (Hong Kong 02)
SOFTLAYER_BARE_METAL HKG02 Xeon_2690 Large Asia (Hong Kong 02)
SOFTLAYER_BARE_METAL HKG02 Xeon_2690_x2 Extra Large Asia (Hong Kong 02)
SOFTLAYER_BARE_METAL HOU02 Xeon_1270 Medium Central US (Houston 02)
SOFTLAYER_BARE_METAL HOU02 Xeon_2690 Large Central US (Houston 02)
SOFTLAYER_BARE_METAL HOU02 Xeon_2690_x2 Extra Large Central US (Houston 02)
SOFTLAYER_BARE_METAL LON02 Xeon_1270 Medium Western Europe (London 02)
SOFTLAYER_BARE_METAL LON02 Xeon_2690 Large Western Europe (London 02)
SOFTLAYER_BARE_METAL LON02 Xeon_2690_x2 Extra Large Western Europe (London 02)
SOFTLAYER_BARE_METAL MEL01 Xeon_1270 Medium Australia (Melbourne 01)
SOFTLAYER_BARE_METAL MEL01 Xeon_2690 Large Australia (Melbourne 01)
SOFTLAYER_BARE_METAL MEL01 Xeon_2690_x2 Extra Large Australia (Melbourne 01)
SOFTLAYER_BARE_METAL MEX01 Xeon_1270 Medium Mexico (Queretaro 01)
SOFTLAYER_BARE_METAL MEX01 Xeon_2690 Large Mexico (Queretaro 01)
SOFTLAYER_BARE_METAL MEX01 Xeon_2690_x2 Extra Large Mexico (Queretaro 01)
SOFTLAYER_BARE_METAL MON01 Xeon_1270 Medium Canada (Montreal 01)
SOFTLAYER_BARE_METAL MON01 Xeon_2690 Large Canada (Montreal 01)
SOFTLAYER_BARE_METAL MON01 Xeon_2690_x2 Extra Large Canada (Montreal 01)
SOFTLAYER_BARE_METAL PAR01 Xeon_1270 Medium Western Europe (Paris 01)
SOFTLAYER_BARE_METAL PAR01 Xeon_2690 Large Western Europe (Paris 01)
SOFTLAYER_BARE_METAL PAR01 Xeon_2690_x2 Extra Large Western Europe (Paris 01)
SOFTLAYER_BARE_METAL SEA01 Xeon_1270 Medium West Coast US (Seattle 01)
SOFTLAYER_BARE_METAL SEA01 Xeon_2690 Large West Coast US (Seattle 01)
SOFTLAYER_BARE_METAL SEA01 Xeon_2690_x2 Extra Large West Coast US (Seattle 01)
SOFTLAYER_BARE_METAL SJC01 Xeon_1270 Medium West Coast US (San Jose 01)
SOFTLAYER_BARE_METAL SJC01 Xeon_2690 Large West Coast US (San Jose 01)
SOFTLAYER_BARE_METAL SJC01 Xeon_2690_x2 Extra Large West Coast US (San Jose 01)
SOFTLAYER_BARE_METAL SNG01 Xeon_1270 Medium Southeast Asia (Singapore 01)
SOFTLAYER_BARE_METAL SNG01 Xeon_2690 Large Southeast Asia (Singapore 01)
SOFTLAYER_BARE_METAL SNG01 Xeon_2690_x2 Extra Large Southeast Asia (Singapore 01)
SOFTLAYER_BARE_METAL SYD01 Xeon_1270 Medium Australia (Sydney 01)
SOFTLAYER_BARE_METAL SYD01 Xeon_2690 Large Australia (Sydney 01)
SOFTLAYER_BARE_METAL SYD01 Xeon_2690_x2 Extra Large Australia (Sydney 01)
SOFTLAYER_BARE_METAL TOK02 Xeon_1270 Medium Japan (Tokyo 02)
SOFTLAYER_BARE_METAL TOK02 Xeon_2690 Large Japan (Tokyo 02)
SOFTLAYER_BARE_METAL TOK02 Xeon_2690_x2 Extra Large Japan (Tokyo 02)
SOFTLAYER_BARE_METAL TOR01 Xeon_1270 Medium Canada (Toronto 01)
SOFTLAYER_BARE_METAL TOR01 Xeon_2690 Large Canada (Toronto 01)
SOFTLAYER_BARE_METAL TOR01 Xeon_2690_x2 Extra Large Canada (Toronto 01)
SOFTLAYER_BARE_METAL WDC01 Xeon_1270 Medium East Coast US (Washington, DC 01)
SOFTLAYER_BARE_METAL WDC01 Xeon_2690 Large East Coast US (Washington, DC 01)
SOFTLAYER_BARE_METAL WDC01 Xeon_2690_x2 Extra Large East Coast US (Washington, DC 01)
GCP asia-east1 n1-highmem-4-1600 High Memory: Bulk Eastern Asia-Pacific (Taiwan)
GCP asia-east1 n1-highmem-4-400 High Memory: Small Eastern Asia-Pacific (Taiwan)
GCP asia-east1 n1-highmem-4-800 High Memory: Balanced Eastern Asia-Pacific (Taiwan)
GCP asia-east1 n1-standard-1 Professional Eastern Asia-Pacific (Taiwan)
GCP asia-east1 n1-standard-2 Tiny Eastern Asia-Pacific (Taiwan)
GCP asia-east1 n1-standard-4-1600 Bulk Eastern Asia-Pacific (Taiwan)
GCP asia-east1 n1-standard-4-400 Small Eastern Asia-Pacific (Taiwan)
GCP asia-east1 n1-standard-4-800 Balanced Eastern Asia-Pacific (Taiwan)
GCP asia-northeast1 n1-highmem-4-1600 High Memory: Bulk Northeastern Asia-pacific (Japan)
GCP asia-northeast1 n1-highmem-4-400 High Memory: Small Northeastern Asia-pacific (Japan)
GCP asia-northeast1 n1-highmem-4-800 High Memory: Balanced Northeastern Asia-pacific (Japan)
GCP asia-northeast1 n1-standard-1 Professional Northeastern Asia-pacific (Japan)
GCP asia-northeast1 n1-standard-2 Tiny Northeastern Asia-pacific (Japan)
GCP asia-northeast1 n1-standard-4-1600 Bulk Northeastern Asia-pacific (Japan)
GCP asia-northeast1 n1-standard-4-400 Small Northeastern Asia-pacific (Japan)
GCP asia-northeast1 n1-standard-4-800 Balanced Northeastern Asia-pacific (Japan)
GCP europe-west1 n1-highmem-4-1600 High Memory: Bulk Western Europe (Belgium)
GCP europe-west1 n1-highmem-4-400 High Memory: Small Western Europe (Belgium)
GCP europe-west1 n1-highmem-4-800 High Memory: Balanced Western Europe (Belgium)
GCP europe-west1 n1-standard-1 Professional Western Europe (Belgium)
GCP europe-west1 n1-standard-2 Tiny Western Europe (Belgium)
GCP europe-west1 n1-standard-4-1600 Bulk Western Europe (Belgium)
GCP europe-west1 n1-standard-4-400 Small Western Europe (Belgium)
GCP europe-west1 n1-standard-4-800 Balanced Western Europe (Belgium)
GCP us-central1 n1-highmem-4-1600 High Memory: Bulk Central US (Iowa)
GCP us-central1 n1-highmem-4-400 High Memory: Small Central US (Iowa)
GCP us-central1 n1-highmem-4-800 High Memory: Balanced Central US (Iowa)
GCP us-central1 n1-standard-1 Professional Central US (Iowa)
GCP us-central1 n1-standard-2 Tiny Central US (Iowa)
GCP us-central1 n1-standard-4-1600 Bulk Central US (Iowa)
GCP us-central1 n1-standard-4-400 Small Central US (Iowa)
GCP us-central1 n1-standard-4-800 Balanced Central US (Iowa)
GCP us-east1 n1-highmem-4-1600 High Memory: Bulk Eastern US (South Carolina)
GCP us-east1 n1-highmem-4-400 High Memory: Small Eastern US (South Carolina)
GCP us-east1 n1-highmem-4-800 High Memory: Balanced Eastern US (South Carolina)
GCP us-east1 n1-standard-1 Professional Eastern US (South Carolina)
GCP us-east1 n1-standard-2 Tiny Eastern US (South Carolina)
GCP us-east1 n1-standard-4-1600 Bulk Eastern US (South Carolina)
GCP us-east1 n1-standard-4-400 Small Eastern US (South Carolina)
GCP us-east1 n1-standard-4-800 Balanced Eastern US (South Carolina)
GCP us-west1 n1-highmem-4-1600 High Memory: Bulk Western US (Oregon)
GCP us-west1 n1-highmem-4-400 High Memory: Small Western US (Oregon)
GCP us-west1 n1-highmem-4-800 High Memory: Balanced Western US (Oregon)
GCP us-west1 n1-standard-1 Professional Western US (Oregon)
GCP us-west1 n1-standard-2 Tiny Western US (Oregon)
GCP us-west1 n1-standard-4-1600 Bulk Western US (Oregon)
GCP us-west1 n1-standard-4-400 Small Western US (Oregon)
GCP us-west1 n1-standard-4-800 Balanced Western 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.

provider data_centre rack_allocation.name
AWS_VPC AP_NORTHEAST_1 ap-northeast-1a
AWS_VPC AP_NORTHEAST_1 ap-northeast-1c
AWS_VPC AP_SOUTHEAST_1 ap-southeast-1a
AWS_VPC AP_SOUTHEAST_1 ap-southeast-1b
AWS_VPC AP_SOUTHEAST_2 ap-southeast-2a
AWS_VPC AP_SOUTHEAST_2 ap-southeast-2b
AWS_VPC EU_CENTRAL_1 eu-central-1a
AWS_VPC EU_CENTRAL_1 eu-central-1b
AWS_VPC EU_WEST_1 eu-west-1a
AWS_VPC EU_WEST_1 eu-west-1b
AWS_VPC EU_WEST_1 eu-west-1c
AWS_VPC SA_EAST_1 sa-east-1a
AWS_VPC SA_EAST_1 sa-east-1c
AWS_VPC US_EAST_1 us-east-1a
AWS_VPC US_EAST_1 us-east-1b
AWS_VPC US_EAST_1 us-east-1c
AWS_VPC US_EAST_1 us-east-1d
AWS_VPC US_EAST_1 us-east-1e
AWS_VPC US_WEST_1 us-west-1b
AWS_VPC US_WEST_1 us-west-1c
AWS_VPC US_WEST_2 us-west-2a
AWS_VPC US_WEST_2 us-west-2b
AWS_VPC US_WEST_2 us-west-2c
AZURE AUSTRALIA_SOUTHEAST fault-domain-0
AZURE AUSTRALIA_SOUTHEAST fault-domain-1
AZURE AUSTRALIA_SOUTHEAST fault-domain-2
AZURE CANADA_CENTRAL fault-domain-0
AZURE CANADA_CENTRAL fault-domain-1
AZURE CANADA_CENTRAL fault-domain-2
AZURE CANADA_EAST fault-domain-0
AZURE CANADA_EAST fault-domain-1
AZURE CANADA_EAST fault-domain-2
AZURE CENTRAL_US fault-domain-0
AZURE CENTRAL_US fault-domain-1
AZURE CENTRAL_US fault-domain-2
AZURE EAST_ASIA fault-domain-0
AZURE EAST_ASIA fault-domain-1
AZURE EAST_ASIA fault-domain-2
AZURE EAST_US fault-domain-0
AZURE EAST_US fault-domain-1
AZURE EAST_US fault-domain-2
AZURE EAST_US_2 fault-domain-0
AZURE EAST_US_2 fault-domain-1
AZURE EAST_US_2 fault-domain-2
AZURE JAPAN_EAST fault-domain-0
AZURE JAPAN_EAST fault-domain-1
AZURE JAPAN_EAST fault-domain-2
AZURE JAPAN_WEST fault-domain-0
AZURE JAPAN_WEST fault-domain-1
AZURE JAPAN_WEST fault-domain-2
AZURE NORTH_EUROPE fault-domain-0
AZURE NORTH_EUROPE fault-domain-1
AZURE NORTH_EUROPE fault-domain-2
AZURE SOUTH_CENTRAL_US fault-domain-0
AZURE SOUTH_CENTRAL_US fault-domain-1
AZURE SOUTH_CENTRAL_US fault-domain-2
AZURE SOUTHEAST_ASIA fault-domain-0
AZURE SOUTHEAST_ASIA fault-domain-1
AZURE SOUTHEAST_ASIA fault-domain-2
AZURE WEST_EUROPE fault-domain-0
AZURE WEST_EUROPE fault-domain-1
AZURE WEST_EUROPE fault-domain-2
AZURE WEST_US fault-domain-0
AZURE WEST_US fault-domain-1
AZURE WEST_US fault-domain-2
SOFTLAYER_BARE_METAL AMS01 AMS01
SOFTLAYER_BARE_METAL AMS03 AMS03
SOFTLAYER_BARE_METAL DAL01 DAL01
SOFTLAYER_BARE_METAL DAL05 DAL05
SOFTLAYER_BARE_METAL DAL06 DAL06
SOFTLAYER_BARE_METAL DAL07 DAL07
SOFTLAYER_BARE_METAL DAL09 DAL09
SOFTLAYER_BARE_METAL FRA02 FRA02
SOFTLAYER_BARE_METAL HKG02 HKG02
SOFTLAYER_BARE_METAL HOU02 HOU02
SOFTLAYER_BARE_METAL LON02 LON02
SOFTLAYER_BARE_METAL MEL01 MEL01
SOFTLAYER_BARE_METAL MEX01 MEX01
SOFTLAYER_BARE_METAL MON01 MON01
SOFTLAYER_BARE_METAL PAR01 PAR01
SOFTLAYER_BARE_METAL SEA01 SEA01
SOFTLAYER_BARE_METAL SJC01 SJC01
SOFTLAYER_BARE_METAL SNG01 SNG01
SOFTLAYER_BARE_METAL SYD01 SYD01
SOFTLAYER_BARE_METAL TOK02 TOK02
SOFTLAYER_BARE_METAL TOR01 TOR01
SOFTLAYER_BARE_METAL WDC01 WDC01
GCP us-west1 us-west1-a
GCP us-west1 us-west1-b
GCP us-central1 us-central1-a
GCP us-central1 us-central1-b
GCP us-central1 us-central1-c
GCP us-central1 us-central1-f
GCP us-east1 us-east1-b
GCP us-east1 us-east1-c
GCP us-east1 us-east1-d
GCP europe-west1 europe-west1-b
GCP europe-west1 europe-west1-c
GCP europe-west1 europe-west1-d
GCP asia-east1 asia-east1-a
GCP asia-east1 asia-east1-b
GCP asia-east1 asia-east1-c
GCP asia-northeast1 asia-northeast1-a
GCP asia-northeast1 asia-northeast1-b
GCP asia-northeast1 asia-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.
  • 429 Too Many Requests: Returned when the request rate exceeds 1 request / 2.5 seconds.
  • 500 Server Error: All other errors.

Last updated:
If you have questions regarding this article, feel free to add it to the comments below.

0 Comments

Please sign in to leave a comment.