创建 Free 集群
本接口可以创建一个 Free 集群。当前,您可以在 Zilliz Cloud 上创建最多一个 Free 集群。关于您可以创建的集群数,可参考[使用限制](/docs/limits#clusters-and-cus)。
POST
/v2/clusters/createFree该 API 的 Base URL 格式如下:
https://api.cloud.zilliz.com.cn
📘说明
控制面接口速率限制为单用户单接口每秒最多 20 个请求。
export BASE_URL="https://api.cloud.zilliz.com.cn"
参数
Authorizationstringheaderrequired
认证令牌,应为具备适当权限的 API 密钥。
示例值:Bearer {{TOKEN}}
Acceptstringheader
使用 application/json
。
示例值:application/json
请求体application/json
export TOKEN="YOUR_API_KEY"
curl --request POST \
--url "${BASE_URL}/v2/clusters/createFree" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
-d '{
"clusterName": "Free-01",
"projectId": "proj-xxxxxxxxxxxxxxxxxxxxxx",
"regionId": "ali-cn-hangzhou"
}'
响应200 - application/json
codeinteger
响应码。
dataobject
响应负载。
clusterIdstring
已创建的集群 ID。
usernamestring
已创建集群的管理用户名。
passwordstring
已创建集群的管理用户密码。该密码仅在集群创建成功时显示一次。建议在安全的地方记录它以备后续使用。
promptstring
返回的提示消息。
Returns an error message.
codeinteger
响应码。
messagestring
错误描述。
{
"code": 0,
"data": {
"clusterId": "inxx-xxxxxxxxxxxxxxx",
"username": "db_xxxxxxxx",
"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."
}
}