Skip to main content

List Clusters

Lists all clusters in the specified cloud region.


GET
https://controller.api.{cloud-region}.zillizcloud.com/v1/clusters

Example

Notes
  • This API requires an API Key as the authentication token.
curl --request GET \
--url "https://controller.api.${CLOUD_REGION}.zillizcloud.com/v1/clusters?pageSize=&current=" \
--header "Authorization: Bearer ${API_KEY}" \
--header "accept: application/json" \
--header "content-type: application/json"

Success response:

{
"code": 200,
"data": {
"count": 0,
"currentPage": 1,
"pageSize": 10,
"clusters": []
}
}

Request

Parameters

  • Query parameters

    ParameterDescription
    pageSizeinteger
    The number of records to return on each page.
    currentinteger
    The current page number.
  • No path parameters required

Request Body

No request body required

Response

Returns a list of your clusters.

Response Bodies

  • Response body if we process your request successfully
{
"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"
}
]
}
}
  • Response body if we failed to process your request
{
"code": integer,
"message": string
}

Properties

The properties in the returned response are listed in the following table.

PropertyDescription
codeinteger
Indicates whether the request succeeds.
  • 200: The request succeeds.
  • Others: Some error occurs.
codeinteger
dataobject
data.countinteger
The total number of clusters returned.
data.currentPageinteger
The current page in the results.
data.pageSizeinteger
The number of clusters per page in the results.
data[].clustersarray
An array of clusters in detail.
data[].clusters[]object
data[].clusters[].clusterIdstring
The ID of the cluster.
data[].clusters[].clusterNamestring
The name of the cluster.
data[].clusters[].descriptionstring
An optional description about the cluster.
data[].clusters[].regionIdstring
The ID of the region where the cluster exists.
data[].clusters[].clusterTypestring
The type of CU associated with the cluster. Possible values are Performance-optimized and Capacity-optimized.
data[].clusters[].cuSizeinteger
The size of the CU associated with the cluster.
data[].clusters[].statusstring
The current status of the cluster. Possible values are INITIALIZING, RUNNING, SUSPENDING, and RESUMING.
data[].clusters[].connectAddressstring
The public endpoint of the cluster. You can connect to the cluster using this endpoint from the public network.
data[].clusters[].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.
data[].clusters[].createTimestring
The time at which the cluster has been created.
messagestring
Indicates the possible reason for the reported error.

Possible Errors

CodeError Message
80001The token is illegal
80002The token is invalid
80003The parameter value for 'pageSize' should be between 5 and 100.
80004The parameter 'currentPage' should have a value between 1 and the maximum value of Int.
90117Invalid domain name used