Manage Cluster

This guide describes the lifecycle of a cluster so that you can make full use of your Zilliz Cloud console to achieve your goals.

You can perform the following operations on a Dedicated cluster.

Rename

1

Navigate to the Cluster Details page of your target cluster.

2

Click on Actions and then select Rename.

3

Enter the new name of the cluster and click on Save.

Edit description

1

Navigate to the Cluster Details page of your target cluster.

2

Hover on the cluster description and click on the Edit description icon.

3

Enter the new description of the cluster and click on Save.

Suspend

For a running Dedicated cluster, you are billed for both CU and storage. To reduce costs, consider suspending the cluster. Only storage charges apply when a Dedicated cluster is suspended.

Please note that during suspension, you cannot perform other actions on the cluster.

You can suspend a cluster via the web console or programmatically.

Cloud Console

Navigate to the Cluster Details page of your target cluster and then follow the instructions below to suspend your Dedicated cluster.

cURL

Your request should resemble the following example, where {API_KEY} is your API key used for authentication.

The following POST request takes a request body and suspends a Dedicated cluster.

bash

curl --request POST \
     --url "https://api.cloud.zilliz.com/v2/clusters/${CLUSTER_ID}/suspend" \
     --header "Authorization: Bearer ${API_KEY}" \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \

# {
#     "code": 0,
#     "data": {
#         "clusterId": "inxx-xxxxxxxxxxxxxxx",
#         "prompt": "Successfully Submitted. The cluster will not incur any computing costs when suspended. You will only be billed for the storage costs during this time."
#     }
# }     

In the command above,

• {API_KEY}: The credential used to authenticate API requests. Replace the value with your own.

• {CLUSTER_ID}: The ID of the Dedicated cluster to suspend.

For details, refer to Suspend Cluster.

Once the suspend operation is successful, a job record will be generated. You can check the progress on the Jobs page.

Resume

Suspended Dedicated clusters can be resumed manually when needed.

Please note that during resuming, you cannot perform other actions on the cluster.

You can resume a cluster via the web console or programmatically.

Cloud Console

Navigate to the Cluster Details page of your target cluster and then follow the instruction below to resume your cluster.

cURL

Your request should resemble the following example, where {API_KEY} is your API key used for authentication.

The following POST request takes a request body and resumes a cluster.

bash

curl --request POST \
     --url "https://api.cloud.zilliz.com/v2/clusters/${CLUSTER_ID}/resume" \
     --header "Authorization: Bearer ${API_KEY}" \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \

# {
#     "code": 0,
#     "data": {
#         "clusterId": "inxx-xxxxxxxxxxxxxxx",
#         "prompt": "successfully Submitted. Cluster is being resumed, which is expected to takes several minutes. 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."
#     }
# }     

In the command above,

• {API_KEY}: The credential used to authenticate API requests. Replace the value with your own.

• {CLUSTER_ID}: The ID of the cluster to resume.

For details, refer to Resume Cluster.

Once the resume operation is successful, a job record will be generated. You can check the progress on the Jobs page.

Upgrade cluster for preview features

To try the latest preview features, you need to upgrade the compatible Milvus version of your dedicated cluster.

Convert to a global cluster

If you need to convert an existing cluster to a global cluster, follow the steps below.

📘Note

Global clusters are compatible only with Milvus 2.6.x. You cannot convert a regular cluster that is compatible with Milvus 3.0.x to a global cluster.

Drop

When a cluster is no longer needed, you can drop it. You can drop a cluster via the web console or programatically.

Cloud Console

Navigate to the Cluster Details page of your target cluster and then follow the instruction below to drop your cluster.

cURL

Your request should resemble the following example, where {API_KEY} is your API key used for authentication.

The following DELETE request takes a request body and drops a cluster.

bash

curl --request POST \
     --url "https://api.cloud.zilliz.com/v2/clusters/${CLUSTER_ID}/drop" \
     --header "Authorization: Bearer ${API_KEY}" \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \

# {
#     "code": 0,
#     "data": {
#         "clusterId": "inxx-xxxxxxxxxxxxxxx",
#         "prompt": "The cluster has been deleted. If you consider this action to be an error, you have the option to restore the deleted cluster from the recycle bin within a 30-day period."
#     }
# }     

In the command above,

• {API_KEY}: The credential used to authenticate API requests. Replace the value with your own.

• {CLUSTER_ID}: The ID of the Dedicated cluster to drop.

For details, refer to Drop Cluster.