Change instance type (vertical scaling)

Learn how to change the instance type for an Exasol deployment using the REST API.

Changing the instance type will result in a system down time of at least several minutes. The database and EXAStorage will be automatically shut down and restarted.

Prerequisites

There are no prerequisites for this procedure.

Procedure

Replace <ip_address>, <database_id>, <cluster_id> and the instance type in the following examples as needed.

  1. If you do not know the name of the database and cluster, you can find it by sending a GET request to the /api/v1/databases endpoint. For example:

    Copy
    curl -X 'GET' \
      'https://<ip_address>:4444/api/v1/databases' \
      -H 'accept: application/json' \
  2. To change the instance type, send a PUT request to the /api/v1/databases/{databaseID}/clusters/{clusterID}/scale endpoint.

    Copy
    curl -X 'PUT' \
      'https://<ip_address>:4444/api/v1/databases/<database_id>/clusters/<cluster_id>/scale' \
      -H 'accept: application/json' \
      -H 'Content-Type: application/json' \
      -d '{
      "instanceType": "c5d.4xlarge"
    }'

Verification

To check which instance type is currently used for the nodes, send a GET request to the /api/v1/databases/{databaseID}/clusters/{clusterID} endpoint.

Copy
# REST call:
curl -X 'GET' \
  'https://<ip_address>:4444/api/v1/databases/<database_id>/clusters/<cluster_id>' \
  -H 'accept: application/json' 
  
# server response (example):   
{
  "status": "running",
  "name": "MY_DATABASE",
  "id": "MY_DATABASE",
  "type": "main",
  "volumeID": "DataVolume1",
  "instanceModel": "c5d.4xlarge",
  "region": "eu-west-1",
  "memorySize": 27968,
  "storageRedundancy": 2,
  "totalNodes": 2,
  "activeNodes": 2,
  "hasSharedNodes": false,
  "auditing": false,
  "version": "8.0.7"
}