修改集群配置

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

该 API 的 Base URL 格式如下：

https://controller.api.${CLOUD_REGION}.zilliz.com.cn

📘说明

你需要将 ${CLOUD_REGION} 替换为您的集群所在区域。
获取云区域 ID 请参考 Zilliz Cloud 控制台或使用查看云区域接口。

export CLOUD_REGION="ali-cn-hangzhou"
export BASE_URL="https://controller.api.${CLOUD_REGION}.zilliz.com.cn"

参数

Authorizationstringheaderrequired

认证令牌，应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 username:password。

示例值：Bearer {{TOKEN}}

CLUSTER_IDstringpathrequired

The ID of the cluster for which you want to modify the configuration.

示例值：{{CLUSTER_ID}}

请求体application/json

cuSizeinteger必填项

集群修改后关联的 CU 大小。

取值范围：≥ 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
}'

响应200 - application/json

SUCCESS

A success response.

codeinteger

响应码。

dataobject

响应载荷，包含已操作集群的 ID。

clusterIdstring

集群 ID。

promptstring

提示信息，表示当前操作成功。

FAILURE

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

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