Skip to main content

Describe Cluster (V2)

Describe a cluster in detail.

GET
/v2/clusters/{CLUSTER_ID}
Base URL

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

https://api.cloud.zilliz.com

📘Notes

The endpoints on the control plane currently supports up to 20 requests per second per user per endpoint.

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
CLUSTER_IDstringpathrequired

ID of the cluster whose details are to return.

Example Value: inxx-xxxxxxxxxxxxxxx
export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"

curl --request GET \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Content-Type: application/json"
Responses200 - application/json
codeinteger

Response code.

dataobject

Response payload.

clusterIdstring

ID of the specified cluster.

clusterNamestring

Name of the cluster.

projectIdstring

ID of the project to which the cluster belongs.

descriptionstring

Description of the cluster.

regionIdstring

ID of the cloud region hosting the cluster.

cuTypestring

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

planstring

Subscription plan of the project to which the cluster belongs. Possible values are Free, Serverless, Standard and Enterprise.

statusstring

Current status of the cluster.

connectAddressstring

Public endpoint of the cluster.

privateLinkAddressstring

Private link of the cluster.

replicastring

Number of replicas of the cluster.

cuSizeinteger

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

Value Range: 0≤ 256
storageSizeinteger

Storage size used by this cluster.

snapshotNumberinteger

Number of backups created.

createProgressinteger

Creation progress of the cluster.

createTimestring

Time at which the cluster has been created.

deploymentOptionstring

Deployment option of the cluster.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 0,
    "data": {
        "clusterId": "in01-108240180a4faf8",
        "clusterName": "dedicated-test",
        "projectId": "proj-b44a39b0c51cf21791a841",
        "description": "",
        "regionId": "aws-us-west-2",
        "cuType": "Performance-optimized",
        "plan": "Enterprise",
        "status": "RUNNING",
        "connectAddress": "https://in01-108240180a4faf8.aws-us-west-2.vectordb.zillizcloud.com:19539",
        "privateLinkAddress": "",
        "createTime": "2024-06-30T16:34:09Z",
        "replica": 1,
        "cuSize": 2,
        "storageSize": 0,
        "snapshotNumber": 0,
        "createProgress": 100,
        "deploymentOption": "Dedicated"
    }
}
{
    "code": 0,
    "data": {
        "clusterId": "in05-991240180a4faf8",
        "clusterName": "Serverless-01",
        "projectId": "proj-b44a39b0c51cf21791a841",
        "description": "",
        "regionId": "gcp-us-west1",
        "cuType": "",
        "plan": "Serverless",
        "status": "RUNNING",
        "connectAddress": "https://in05-991240180a4faf8.gcp-us-west1.cloud.zilliz.com",
        "privateLinkAddress": "",
        "createTime": "2024-06-29T16:35:09Z",
        "replica": 1,
        "cuSize": 0,
        "storageSize": 0,
        "snapshotNumber": 0,
        "createProgress": 100
    }
}
{
    "code": 0,
    "data": {
        "clusterId": "in03-112340180a4faf8",
        "clusterName": "Free-01",
        "projectId": "proj-b44a39b0c51cf21791a841",
        "description": "",
        "regionId": "gcp-us-west1",
        "cuType": "",
        "plan": "Free",
        "status": "RUNNING",
        "connectAddress": "https://in03-112340180a4faf8.api.gcp-us-west1.zillizcloud.com",
        "privateLinkAddress": "",
        "createTime": "2024-06-24T12:35:09Z",
        "replica": 1,
        "cuSize": 0,
        "storageSize": 0,
        "snapshotNumber": 0,
        "createProgress": 100
    }
}