Skip to main content

Modify Cluster

Modifies the configuration of a cluster. Currently, you can use this API to upgrade the CU size of your dedicated cluster

POST
/v1/clusters/{CLUSTER_ID}/modify
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 for which you want to modify the configuration.

Example Value: {{CLUSTER_ID}}
Request Bodyapplication/json
cuSizeintegerrequired

The size of CU to be associated with your cluster after modification.

Value Range: ≥ 1≤ 256
export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="{{CLUSTER_ID}}"

curl --request POST \
--url "${BASE_URL}/v1/clusters/${CLUSTER_ID}/modify" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "cuSize": 2
}'
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. Cluster is being upgraded, which is expected to take 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."
    }
}