Create Cluster

Creates a new cluster.

---

POST

https://controller.${CLOUD_REGION}.zillizcloud.com/v1/clusters/create

---

Example

📘Notes

This API requires an API key as the authentication token.

export CLOUD_REGION="gcp-us-west1"
export API_KEY=""

curl --location --request POST "https://controller.api.${CLOUD_REGION}.zillizcloud.com/v1/clusters/create" \
--header "Authorization: Bearer ${API_KEY}" \
--data-raw '{
    "cuSize": 1,
    "clusterName": "Cluster-02",
    "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxx",
    "plan": "Standard",
    "cuType": "Performance-optimized"
}'

Possible response is similar to the following.

{
    "code": 200,
    "data": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "username": "db_admin",
        "password": "xxxxxxxxxxxxxxxx",
        "prompt": "Submission successful, Cluster is being created, You can use the DescribeCluster interface to obtain the creation progress and the status of the Cluster. When the Cluster status is RUNNING, you can access your vector database using the SDK with the admin account and the initialization password you provided."
    }
}

Request

Parameters

• No query parameters required

• No path parameters required

• Header parameters

  Parameter	Description
  Authorization	string

Request Body

{
    "plan": "string",
    "clusterName": "string",
    "cuSize": "integer",
    "cuType": "string",
    "projectId": "string"
}

Parameter	Description
plan	string The plan tier of the Zilliz Cloud service. Possible values: "Standard", "Enterprise"
clusterName	string The name of the cluster to be created. It is a string of no more than 32 characters.
cuSize	integer The size of the CU to be used for the created cluster. It is an integer from 1 to 256.
cuType	string The type of the CU used for the Zilliz Cloud cluster to be created. The value defaults to Performance-optimized Possible values: "Performance-optimized", "Capacity-optimized"
projectId	string The ID of the project where the cluster is to be created.

Response

Returns an object that contains the details of the created cluster.

Response Body

{
    "code": "integer",
    "data": {
        "clusterId": "string",
        "username": "string",
        "password": "string",
        "prompt": "string"
    }
}

Property	Description
code	integer Indicates whether the request succeeds. 0: The request succeeds. Others: Some error occurs.
data	object
data.clusterId	string The ID of the cluster affected by this operation.
data.username	string The name of the cluster user generated by default.
data.password	string The password of the cluster user generated by default. It will not be displayed again, so note it down and securely store it.
data.prompt	string The statement indicating that this operation succeeds.

Error Response

{
    "code": integer,
    "message": string
}

Property	Description
code	integer Indicates whether the request succeeds. 0: The request succeeds. Others: Some error occurs.
message	string Indicates the possible reason for the reported error.