Describe Cluster
Describes a cluster in detail.
The base URL for this API is in the following format:
https://controller.api.${CLOUD_REGION}.zillizcloud.com
- 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"
The authentication token should be an API key with appropriate privileges.
The ID of the cluster.
export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"
curl --request GET \
--url "${BASE_URL}/v1/clusters/${CLUSTER_ID}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"
A success response.
Response code.
Response payload, which details the cluster.
The ID of the cluster.
The name of the cluster.
An optional description of the cluster.
The ID of the cloud region where the cluster exists.
The type of CU associated with the cluster.
The subscription plan of the cluster.
The size of the CU used by the cluster.
The current status of the cluster.
The public endpoint of the cluster. You can connect to the cluster using this endpoint from the public network.
The private endpoint of the cluster. You can set up a private link to allow your VPS in the same cloud region to access your cluster.
The time at which the cluster has been created.
The storage size of the cluster.
The number of snapshofts created from the cluster.
The creation progress of the cluster.
The ID of the project where the cluster resides.
Returns an error message.
Response code.
Error message.
{
"code": 200,
"data": {
"clusterId": "inxx-xxxxxxxxxxxxxxx",
"clusterName": "Cluster-02",
"description": "",
"regionId": "gcp-us-west1",
"clusterType": "Performance-optimized",
"plan": "Standard",
"cuSize": 1,
"status": "RUNNING",
"connectAddress": "https://inxx-xxxxxxxxxxxxxxx.gcp-us-west1.vectordb.zillizcloud.com:19530",
"privateLinkAddress": "",
"createTime": "2024-07-22T07:43:04Z",
"storageSize": 0,
"snapshotNumber": 0,
"createProgress": 100,
"projectId": "proj-xxxxxxxxxxxxxxxxxxxxxx"
}
}