Skip to main content

Create Dedicated Cluster

Create a dedicated cluster.

POST
/v2/clusters/createDedicated
Base URL

The base URL for this API is in the following format:

https://api.cloud.zilliz.com

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

The authentication token should be an API key with appropriate privileges.

Example Value: Bearer {{TOKEN}}
Acceptstringheader

Use application/json.

Example Value: application/json
Request Bodyapplication/json
clusterNamestringrequired

Name of the cluster to create.

projectIdstringrequired

ID of the project to which the cluster belongs.

regionIdstringrequired

ID of the cloud region hosting the cluster.

planstringrequired

Subscription plan of the cluster.

cuTypestringrequired

CU type of the cluster.
This applies to dedicated clusters only. For free and serverless clusters, the value is empty.

cuSizeintegerrequired

CU size of the cluster. For free and serverless clusters, the value is always 0.

Value Range: ≥ 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": "aws-us-west-2",
    "plan": "Standard",
    "cuType": "Performance-optimized",
    "cuSize": 1
}'
Responses200 - application/json
codeinteger

Response code.

dataobject

Response payload.

clusterIdstring

ID of the cluster created.

usernamestring

Name of the cluster administration user named db_admin.

passwordstring

Password of the cluster administration user. This value shows up only once when the cluster is created. You are advised to record it securely.

promptstring

Prompt messages returned.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

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