Skip to main content

Create Cluster

Creates a new cluster.

POST
/v1/clusters/create
Base URL

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

https://controller.api.${CLOUD_REGION}.zillizcloud.com

📘Notes
  • You need to replace ${CLOUD_REGION} with the appropriate region for your deployment.
  • To get the cloud region ID, refer to Zilliz Cloud Console or List Cloud Regions.
export CLOUD_REGION="gcp-us-west1"
export BASE_URL="https://controller.api.${CLOUD_REGION}.zillizcloud.com"
Parameters
Authorizationstringheaderrequired

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

Example Value: Bearer {{TOKEN}}
Request Bodyapplication/json
planstringrequired

The subscription plan of the cluster to be created.

clusterNamestringrequired

The name of the cluster to create.

cuSizeintegerrequired

The size of CU used for the cluster.

Value Range: ≥ 1≤ 256
cuTypestringrequired

The type of CU used for the cluster.

projectIdstringrequired

The ID of the project where the cluster is to be created.

Example Value: proj-xxxxxxxxxxxxxxxxxxxxxx
export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${BASE_URL}/v1/clusters/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "cuSize": 1,
    "clusterName": "Cluster-02",
    "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxx",
    "plan": "Standard",
    "cuType": "Performance-optimized"
}'
Responses200 - application/json

A success response.

codeinteger

Response code.

dataobject

Response payload which is an object containing information about the created dedicated cluster.

clusterIdstring

The ID of the cluster affected by this operation.

usernamestring

The name of the cluster user generated by default.

passwordstring

The password of the cluster user generated by default. It will not be displayed again, so note it down and securely store it.

promptstring

The statement indicating that this operation succeeds.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 200,
    "data": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "username": "db_admin",
        "password": "xxxxxxxxxxxxxxxx",
        "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."
    }
}