Modify Cluster

Modify the configuration of a specified cluster. Currently, you can use this API to change the size of the CU associated with your cluster.

---

POST

https://controller.${CLOUD_REGION}.zillizcloud.com/v1/clusters/{CLUSTER_ID}/modify

---

Example

📘Notes

• This API requires an API key as the authentication token.
• This API requires applies only to dedicated clusters.

export CLOUD_REGION="gcp-us-west1"
export API_KEY=""

curl --location --request POST 'https://controller.api.${CLOUD_REGION}.cloud-uat3.zilliz.com/v1/clusters/inxx-xxxxxxxxxxxxxxx/modify' \
--header "Authorization: Bearer ${API_KEY}" \
--data-raw '{
    "cuSize": 2
}'

Possible return is similar to the following.

{
    "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."
    }
}

Request

Parameters

• No query parameters required

• Path parameters

  Parameter	Description
  CLUSTER_ID	string(required)

• Header parameters

  Parameter	Description
  Authorization	string

Request Body

{
    "cuSize": "integer"
}

Parameter	Description
cuSize	integer The size of the CU to be associated to your cluster after the configuration.

Response

Returns the ID of the affected cluster.

Response Body

{
    "code": "integer",
    "data": {
        "clusterId": "string",
        "prompt": "string"
    }
}

Property	Description
code	integer Indicates whether the request succeeds. 0: The request succeeds. Others: Some error occurs.
data	object
data.clusterId	string The ID of a cluster.
data.prompt	string The statement indicating that the current operation succeeds.

Error Response

{
    "code": integer,
    "message": string
}

Property	Description
code	integer Indicates whether the request succeeds. 0: The request succeeds. Others: Some error occurs.
message	string Indicates the possible reason for the reported error.