Resume Cluster

Resume a dedicated cluster.

POST

/v2/clusters/{CLUSTER_ID}/resume

Base URL

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

https://api.cloud.zilliz.com

export BASE_URL="https://api.cloud.zilliz.com"

Parameters

Authorizationstringheaderrequired

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

Example Value: Bearer {{TOKEN}}

Acceptstringheader

Use application/json.

Example Value: application/json

CLUSTER_IDstringpathrequired

ID of the cluster to resume.

Example Value: inxx-xxxxxxxxxxxxxxx

export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"

curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/resume" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Content-Type: application/json"

Responses200 - application/json

SUCCESS

codeinteger

Response code.

dataobject

Response payload.

clusterIdstring

ID of the cluster that has been resumed.

promptstring

Prompt message returned.

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 0,
    "data": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "prompt": "successfully Submitted. Cluster is being resumed, which is expected to takes several minutes. You can access data about the creation progress and status of your cluster by DescribeCluster API. Once the cluster status is RUNNING, you may access your vector database using the SDK."
    }
}