List Clusters

Lists all clusters in the specified cloud region.

---

GET

https://controller.${CLOUD_REGION}.zillizcloud.com/v1/clusters

---

Example

📘Notes

This API requires an API key as the authentication token.

export CLOUD_REGION="gcp-us-west1"
export API_KEY=""

curl --location --request GET "https://controller.api.${CLOUD_REGION}.zillizcloud.com/v1/clusters?pageSize=10&current=1" \
--header "Authorization: Bearer ${API_KEY}"

Possible response is similar to the following.

{
    "code": 200,
    "data": {
        "count": 1,
        "currentPage": 1,
        "pageSize": 10,
        "clusters": [
            {
                "clusterId": "inxx-xxxxxxxxxxxxxxx",
                "clusterName": "Cluster-01",
                "description": "",
                "regionId": "gcp-us-west1",
                "clusterType": "Cost-optimized",
                "plan": "Free",
                "cuSize": 0,
                "status": "RUNNING",
                "connectAddress": "https://inxx-xxxxxxxxxxxxxxx.api.gcp-us-west1.zillizcloud.com",
                "privateLinkAddress": "",
                "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxx",
                "createTime": "2024-04-01T06:42:31Z"
            }
        ]
    }
}

Request

Parameters

• Query parameters

  Parameter	Description
  pageSize	integer The number of records to return on each page.
  current	integer The current page number.

• No path parameters required

• Header parameters

  Parameter	Description
  Authorization	string

Request Body

No request body required

Response

Returns a list of your clusters.

Response Body

{
    "code": "integer",
    "data": {
        "count": "integer",
        "currentPage": "integer",
        "pageSize": "integer",
        "clusters": [
            {
                "clusterId": "string",
                "clusterName": "string",
                "description": "string",
                "regionId": "string",
                "clusterType": "string",
                "cuSize": "integer",
                "status": "string",
                "connectAddress": "string",
                "privateLinkAddress": "string",
                "createTime": "string"
            }
        ]
    }
}

Property	Description
code	integer Indicates whether the request succeeds. 0: The request succeeds. Others: Some error occurs.
data	object
data.count	integer The total number of clusters returned.
data.currentPage	integer The current page in the results.
data.pageSize	integer The number of clusters per page in the results.
data[].clusters	array An array of clusters in detail.
data[].clusters[]	object
data[].clusters[].clusterId	string The ID of the cluster.
data[].clusters[].clusterName	string The name of the cluster.
data[].clusters[].description	string An optional description about the cluster.
data[].clusters[].regionId	string The ID of the region where the cluster exists.
data[].clusters[].clusterType	string The type of CU associated with the cluster. Possible values are Performance-optimized and Capacity-optimized.
data[].clusters[].cuSize	integer The size of the CU associated with the cluster.
data[].clusters[].status	string The current status of the cluster. Possible values are INITIALIZING, RUNNING, SUSPENDING, and RESUMING.
data[].clusters[].connectAddress	string The public endpoint of the cluster. You can connect to the cluster using this endpoint from the public network.
data[].clusters[].privateLinkAddress	string 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.
data[].clusters[].createTime	string The time at which the cluster has been created.

Error Response

{
    "code": integer,
    "message": string
}

Property	Description
code	integer Indicates whether the request succeeds. 0: The request succeeds. Others: Some error occurs.
message	string Indicates the possible reason for the reported error.