Skip to main content

Suspend Cluster

Suspends a specified cluster. This operation will only stop the cluster and your data will remain intact.

POST
/v1/clusters/{CLUSTER_ID}/suspend
Base URL

The base URL for this API is in the following format:

https://controller.api.${CLOUD_REGION}.zillizcloud.com

📘Notes
  • You need to replace ${CLOUD_REGION} with the appropriate region for your deployment.
  • To get the cloud region ID, refer to Zilliz Cloud Console or List Cloud Regions.
export CLOUD_REGION="gcp-us-west1"
export BASE_URL="https://controller.api.${CLOUD_REGION}.zillizcloud.com"
Parameters
Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges.

Example Value: Bearer {{TOKEN}}
CLUSTER_IDstringpathrequired

The ID of the cluster to suspend.

Example Value: {{CLUSTER_ID}}
export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="{{CLUSTER_ID}}"

curl --request POST \
--url "${BASE_URL}/v1/clusters/${CLUSTER_ID}/suspend" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"
Responses200 - application/json

A success response.

codeinteger

Response code.

dataobject

Response payload which is an object containing the ID of the cluster.

clusterIdstring

The ID of the cluster.

promptstring

The statement indicating that the current operation succeeds.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 200,
    "data": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "prompt": "successfully Submitted. The cluster will not incur any computing costs when suspended. You will only be billed for the storage costs during this time."
    }
}