Skip to main content

Describe Cluster

Describe a cluster in detail.


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

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/${clusterId}" \
--header "Authorization: Bearer ${API_KEY}" \
--header "accept: application/json" \
--header "content-type: application/json"

Success response:

{
"code": 200,
"data": {
"clusterId": "in03-***************",
"clusterName": "Cluster-01",
"description": "",
"regionId": "gcp-us-west1",
"clusterType": "",
"cuSize": 0,
"status": "RUNNING",
"connectAddress": "https://in03-***************.api.gcp-us-west1.cloud-uat3.zilliz.com",
"privateLinkAddress": "",
"createTime": "2023-12-12T11:32:43Z",
"storageSize": 0,
"snapshotNumber": 0,
"createProgress": 100
}
}

Request

Parameters

  • No query parameters required

  • Path parameters

    ParameterDescription
    CLUSTER_IDstring(required)

Request Body

No request body required

Response

Returns an array of clusters in detail.

Response Bodies

  • Response body if we process your request successfully
{
"code": "integer",
"data": {
"clusterId": "string",
"clusterName": "string",
"description": "string",
"regionId": "string",
"clusterType": "string",
"cuSize": "integer",
"status": "string",
"connectAddress": "string",
"privateLinkAddress": "string",
"createTime": "string",
"storageSize": "integer",
"snapshotNumber": "integer",
"createProgress": "integer"
}
}
  • 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.clusterIdstring
The ID of the cluster.
data.clusterNamestring
The Name of the cluster.
data.descriptionstring
An optional description of the cluster.
data.regionIdstring
The ID of the cloud region where the cluster exists.
data.clusterTypestring
The type of the CU associated with the cluster.
data.cuSizeinteger
The size of the CU used by the cluster.
data.statusstring
The current status of the cluster. Possible values are CREATING, RUNNING, SUSPENDING, and RESUMING.
data.connectAddressstring
The public endpoint of the cluster. You can use this to connect to your cluster from public networks.
data.privateLinkAddressstring
The private endpoint of the cluster. You can use this to connect to your cluster from your VPSs in the same cloud region.
data.createTimestring
The time when this cluster has been creaated.
data.storageSizeinteger (sint64)
The storage size of the cluster.
data.snapshotNumberinteger
The number of snapshofts created from the cluster.
data.createProgressinteger
The creation progress of the cluster.
messagestring
Indicates the possible reason for the reported error.

Possible Errors

CodeError Message
80001The token is illegal
80002The token is invalid
80020Cluster not exist or you don't have permission.
90103The clusterId parameter is empty in the request path.
90117Invalid domain name used