创建 Serverless 集群

Create serverless cluster.

POST

/v2/clusters/createServerless

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必填项

待创建集群所属项目 ID。

示例值：proj-xxxxxxxxxxxxxxxxxxxx

regionIdstring必填项

计划托管待创建集群的云地域 ID。

export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${BASE_URL}/v2/clusters/createServerless" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
-d '{
    "clusterName": "Serverless-05",
    "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxxx",
    "regionId": "ali-cn-hangzhou"
}'

响应200 - application/json

SUCCESS

codeinteger

响应码。

dataobject

响应负载。

clusterIdstring

已创建的集群 ID。

usernamestring

已创建集群的管理用户名。

passwordstring

已创建集群的管理用户密码。该密码仅在集群创建成功时显示一次。建议在安全的地方记录它以备后续使用。

promptstring

返回的提示信息。

FAILURE

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

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