Stop a Cluster

This page provides information on how to stop a single cluster.

You must stop all worker clusters before stopping the main cluster.

Prerequisites

The cluster must be running. For more information see, Start a Cluster.

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 stop a cluster, send a PUT request to the /api/v1/databases/DATABASE_ID/clusters/CLUSTER_ID/stop endpoint that stops the cluster. For example:

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

    If you want to also stop the nodes after stopping the cluster, add ?stopInstances=true after the endpoint. For example: 

    curl -k -X "PUT" \
    "https://$EXASOL_IP/api/v1/databases/$DATABASE_NAME/clusters/$CLUSTER_ID/stop?stopInstances=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 "stopped".