Stop a Cluster

This article explains how to stop a cluster.

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

This procedure is carried out using the Administration API.

Prerequisites

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

Procedure

The following examples use curl on a Linux terminal. You can also use other interfaces and languages to execute the curl commands.

Placeholder values in the examples are styled as Bash variables, for example: $NODE_IP. Replace these placeholders with your own values.

The option --insecure or -k tells curl to bypass the TLS certificate check. This option allows you to connect to a HTTPS server that does not have a valid certificate. Only use this option if certificate verification is not possible and you trust the server.

  1. To get information about the database, send a GET request to the /api/v1/databases endpoint.

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

    The response includes the database ID, name, and version. Additional details are included 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 --insecure -X "GET" \
    "https://$NODE_IP:4444/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. For example:

    curl -k -X "PUT" \
    "https://$NODE_IP:4444/api/v1/databases/$DATABASE_ID/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://$NODE_IP:4444/api/v1/databases/$DATABASE_ID/clusters/$CLUSTER_ID/stop?stopInstances=true" \
    -H "accept: application/json" \
    -H "Authorization: Basic $AUTH_TOKEN"

Verification

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

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

The cluster status should be stopped.