Modify Cluster (V2)
Modify a dedicated cluster. You can increase or reduce the number of CUs allocated to the cluster.
The base URL for this API is in the following format:
https://api.cloud.zilliz.com
The endpoints on the control plane currently supports up to 20 requests per second per user per endpoint.
export BASE_URL="https://api.cloud.zilliz.com"
The authentication token should be an API key with appropriate privileges.
Use application/json.
ID of the cluster to modify.
Number of CUs allocated to this cluster after the modification. This parameter and autoscaling.cu are mutually exclusive; you can specify only one of them. The product of this parameter and replica should not exceed 1024.
For dedicated clusters in Standard plan, the value can be 1 to 32, and possible values can be 1, 2, 4, 8, 12, 16, 20, 24, 28, 32.
For dedicated clusters in Enterprise plan, the value can be 1 to 1,024, and possible values can be 1, 2, 4, 8, 12, 16, 20, 24, 28, 32,…,64, 72, 80, 88,…,256, 272, 288, …,1024.
For details on the increment rules for the CU size, refer to the Deployment section in Detailed Plan Comparison.
Number of replicas for this cluster after the modification. This parameter and autoscaling.replica are mutually exclusive; you can specify only one of them. The product of this parameter and cuSize should not exceed 1024.
Auto-scaling configuration for the cluster. This parameter and cuSize or replica are mutually exclusive; you can specify only one of them.
Auto-scaling configuration for CUs. This is unavailable if you have already set cuSize. The product of the maximum number of CUs and the maximum number of replicas should not exceed 1024.
Minimum number of CUs for auto-scaling. This parameter and schedules are mutually exclusive; you can specify only one of them.
Maximum number of CUs for auto-scaling. This parameter and schedules are mutually exclusive; you can specify only one of them.
Auto-scaling schedules. This parameter and min/max are mutually exclusive; you can specify only one of them.
An auto-scaling schedule.
Cron expression defining the schedule.
Target number of CUs for this schedule.
Auto-scaling configuration for replicas. This is unavailable if you have already set replica. The product of the maximum number of CUs and the maximum number of replicas should not exceed 256.
Minimum number of replicas for auto-scaling. This parameter and schedules are mutually exclusive; you can specify only one of them.
Maximum number of replicas for auto-scaling. This parameter and schedules are mutually exclusive; you can specify only one of them.
Auto-scaling schedules. This parameter and min/max are mutually exclusive; you can specify only one of them.
An auto-scaling schedule.
Cron expression defining the schedule.
Target number of replicas for this schedule.
export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"
curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/modify" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
-d '{
"cuSize": 2,
"replica": 2
}'
export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"
curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/modify" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
-d '{
"autoscaling": {
"cu": {
"min": 1,
"max": 2
},
"replica": {
"min": 1,
"max": 2
}
}
}'
export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"
curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/modify" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
-d '{
"autoscaling": {
"cu": {
"schedules": [
{
"cron": "10 0 0 0 0 ?",
"target": 2
}
]
},
"replica": {
"schedules": [
{
"cron": "10 0 0 0 0 ?",
"target": 2
}
]
}
}
}'
Response code.
Response payload.
ID of the cluster that has been modified.
Prompt message returned.
Returns an error message.
Response code.
Error message.
{
"code": 0,
"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."
}
}