Describe Cluster

Describes a cluster in detail.

GET

/v1/clusters/{CLUSTER_ID}

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 On 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}}

CLUSTER_IDstringpathrequired

The ID of the cluster.

Example Value: inxx-xxxxxxxxxxxxxxx

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"

Responses200 - application/json

SUCCESS

A success response.

codeinteger

Response code.

dataobject

Response payload, which details the cluster.

clusterIdstring

The ID of the cluster.

clusterNamestring

The name of the cluster.

descriptionstring

An optional description of the cluster.

regionIdstring

The ID of the cloud region where the cluster exists.

clusterTypestring

The type of CU associated with the cluster.

Possible Values:

Performance-optimizedCapacity-optimized

planstring

The subscription plan of the cluster.

Possible Values:

StandardEnterpriseServerlessFree

cuSizeinteger

The size of the CU used by the cluster.

statusstring

The current status of the cluster.

Possible Values:

CREATINGRUNNINGDELETINGDELETEDSTOPPINGRESUMINGMODIFYINGABNORMALFREEZINGFROZEN

connectAddressstring

The public endpoint of the cluster. You can connect to the cluster using this endpoint from the public network.

privateLinkAddressstring

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.

createTimestring

The time at which the cluster has been created.

storageSizeinteger<sint64>

The storage size of the cluster.

snapshotNumberinteger

The number of snapshofts created from the cluster.

createProgressinteger

The creation progress of the cluster.

Value Range: 0≤ 100

projectIdstring

The ID of the project where the cluster resides.

FAILURES

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "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"
    }
}