List Clusters

Lists all clusters in the specified cloud region.

GET

/v1/clusters

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

pageSizeintegerquery

The number of records to return on each page.

Example Value: 0

currentintegerquery

The current page number.

Example Value: 0

export TOKEN="YOUR_API_KEY"

curl --request GET \
--url "${BASE_URL}/v1/clusters" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"

Responses200 - application/json

FAILURE

Returns a list of clusters.

codeinteger

Response code.

dataobject

Response payload, which is a list of clusters.

countinteger

The total number of clusters returned.

currentPageinteger

The current page in the results.

pageSizeinteger

The number of clusters per page in the results.

clustersarray

An array of clusters in detail.

[]clustersobject

A cluster.

clusterIdstring

The ID of the cluster.

clusterNamestring

The name of the cluster.

descriptionstring

An optional description about the cluster.

regionIdstring

The ID of the region where the cluster exists.

clusterTypestring

The type of CU associated with the cluster.

Possible Values:

planstring

The subscription plan associated with the cluster.

Possible Values:

cuSizeinteger

The size of the CU associated with the cluster.

statusstring

The current status of the cluster.

Possible Values:

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.

projectIdstring

The ID of the project where the cluster resides.

createTimestring

The time at which the cluster has been created.

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 200,
    "data": {
        "count": 2,
        "currentPage": 1,
        "pageSize": 10,
        "clusters": [
            {
                "clusterId": "inxx-xxxxxxxxxxxxxxx",
                "clusterName": "Dedicated-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": "",
                "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxx",
                "createTime": "2024-07-22T04:28:05Z"
            },
            {
                "clusterId": "inxx-xxxxxxxxxxxxxxx",
                "clusterName": "Dedicated-01",
                "description": "",
                "regionId": "az-westus3",
                "clusterType": "Performance-optimized",
                "plan": "Standard",
                "cuSize": 1,
                "status": "RUNNING",
                "connectAddress": "https://inxx-xxxxxxxxxxxxxxx.az-westus3.vectordb.zillizcloud.com:19530",
                "privateLinkAddress": "",
                "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxx",
                "createTime": "2024-07-22T04:25:36Z"
            }
        ]
    }
}