List Clusters

List all clusters scoped to API Key.

GET

/v2/clusters

Base URL

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

https://api.cloud.zilliz.com

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

pageSizeintegerquery

The number of records to include in each response.

Example Value: 10

currentPageintegerquery

The current page number.

Example Value: 1

export TOKEN="YOUR_API_KEY"

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

Responses200 - application/json

SUCCESS

codeinteger

Response code.

dataarray

Response payload.

[]dataobject

List of clusters in detail.

clusterIdstring

ID of a cluster.

clusterNamestring

Name of the cluster.

descriptionstring

Description of the cluster.

regionIdstring

ID of the cloud region hosting the cluster.

planstring

Subscription plan of the cluster.

Possible Values:

FreeServerlessStandardEnterprise

cuTypestring

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

Possible Values:

Performance-optimizedCapacity-optimized

cuSizeinteger

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

Value Range: 0≤ 256

statusstring

Current status of the cluster.

Possible Values:

CREATINGRUNNINGDELETINGDELETEDSTOPPINGRESUMINGMODIFYINGABNORMALFREEZINGFROZEN

connectAddressstring

Public endpoint of the cluster.

privateLinkAddressstring

Private link of the cluster.

projectIdstring

ID of the project to which the cluster belongs.

createTimestring

Time at which the cluster has been created.

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 0,
    "data": {
        "count": 1,
        "currentPage": 1,
        "pageSize": 10,
        "clusters": [
            {
                "clusterId": "inxx-xxxxxxxxxxxxxxx",
                "clusterName": "dedicated-3",
                "description": "",
                "regionId": "aws-us-west-2",
                "plan": "Standard",
                "cuType": "Performance-optimized",
                "cuSize": 1,
                "status": "RUNNING",
                "connectAddress": "https://inxx-xxxxxxxxxxxxxxx.aws-us-west-2.vectordb.zillizcloud.com:19530",
                "privateLinkAddress": "",
                "createTime": "2024-06-30T16:49:50Z",
                "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxx"
            }
        ]
    }
}