Start a Cluster

This page provides information on how to start a cluster.

Prerequisites

  • The cluster must be stopped. For more information see, Stop a Cluster.

  • If the cluster you are starting is a worker cluster, the main cluster must be running.

Procedure

This procedure can be carried out using the Administration API.

The examples in this procedure are written using Bash on a Linux terminal. You can also use other interfaces and languages to execute the curl commands.

Placeholder values are styled as Bash variables, starting with the dollar sign ($) and using UPPERCASE characters. Replace the placeholders with your own values before executing the curl command.

  1. Get information about the database by sending a GET request to the /api/v1/databases endpoint. For example:

    curl -k -X "GET" \
    "https://$EXASOL_IP/api/v1/databases" \
    -H "accept: application/json" \
    -H "Authorization: Basic $AUTH_TOKEN"

    The response will include the following:

    • Database ID
    • Database name
    • Database version
    • Provider type
    • Number of clusters in the database
    • Number of clusters running
    • Volumes

    Additional database parameters and hardware details may be included in the response depending on the configuration and platform.

  2. To find cluster information, send a GET request to the /api/v1/databases/DATABASE_ID/clusters endpoint. For example:

    curl -k -X "GET" \
    "https://$EXASOL_IP/api/v1/databases/$DATABASE_ID/clusters" \
    -H "accept: application/json" \
    -H "Authorization: Basic $AUTH_TOKEN"

  3. To start a cluster, send a PUT request to the /api/v1/databases/DATABASE_ID/clusters/CLUSTER_ID/start endpoint that starts the cluster. For example:

    curl -k -X "PUT" \
    "https://$EXASOL_IP/api/v1/databases/$DATABASE_ID/clusters/$CLUSTER_ID/start" \
    -H "accept: application/json" \
    -H "Authorization: Basic $AUTH_TOKEN"

    If the cluster nodes are offline and you want to start the nodes before the cluster starts up, add ?startInstances=true after the endpoint name. For example:

    curl -k -X "PUT" \
    "https://$EXASOL_IP/api/v1/databases/$DATABASE_ID/clusters/$CLUSTER_ID/start?startInstances=true" \
    -H "accept: application/json" \
    -H "Authorization: Basic $AUTH_TOKEN"

Verification

To verify, send a GET request to the /api/v1/databases/DATABASE_ID/clusters endpoint. For example:

curl -k -X "GET" \
"https://$EXASOL_IP/api/v1/databases/$DATABASE_ID/clusters" \
-H "accept: application/json" \
-H "Authorization: Basic $AUTH_TOKEN"

The cluster status is "running".