创建 Dedicated 集群

Create a dedicated cluster.

POST

/v2/clusters/createDedicated

Base URL

该 API 的 Base URL 格式如下：

https://api.cloud.zilliz.com

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

参数

Authorizationstringheaderrequired

认证令牌，应为具备适当权限的 API 密钥。

示例值：Bearer {{TOKEN}}

Acceptstringheader

使用 application/json。

示例值：application/json

请求体application/json

clusterNamestring必填项

待创建集群名称。

projectIdstring必填项

待创建集群所属项目。

regionIdstring必填项

待创建集群所在云地域。

planstring必填项

待创建集群所属的订阅计划。

枚举值：

StandardEnterprise

cuTypestring必填项

待创建集群使用的 CU 类型。
仅适用于 Dedicated 集群。对于 Free 和 Serverless 集群，该值为空。

枚举值：

Performance-optimizedCapacity-optimized

cuSizeinteger必填项

待创建集群使用的 CU 大小。对于 Free 和 Serverless 集群，该值始终为 0。

取值范围：≥ 1≤ 256

export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${BASE_URL}/v2/clusters/createDedicated" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
-d '{
    "clusterName": "Cluster-05",
    "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxx",
    "regionId": "ali-cn-hangzhou",
    "plan": "Standard",
    "cuType": "Performance-optimized",
    "cuSize": 1
}'

响应200 - application/json

SUCCESS

codeinteger

响应码。

dataobject

响应负载。

clusterIdstring

已创建集群的 ID。

usernamestring

集群管理用户名称。通常为 db_admin。

passwordstring

集群管理用户密码。该值仅在创建集群时显示一次。建议您妥善保存。

promptstring

返回的提示信息。

FAILURE

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "code": 0,
    "data": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "username": "db_admin",
        "password": "****************",
        "prompt": "successfully submitted, cluster is being created. 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 with the admin account and the initial password you specified."
    }
}