Describe Cluster

Describe a cluster in detail.

---

GET

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

---

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/inxx-xxxxxxxxxxxxxxx" \
--header "Authorization: Bearer ${API_KEY}"

Possible response is similar to the following.

{
    "code": 200,
    "data": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "clusterName": "Cluster-01",
        "description": "",
        "regionId": "gcp-us-west1",
        "clusterType": "",
        "plan": "Free",
        "cuSize": 0,
        "status": "DELETED",
        "connectAddress": "https://inxx-xxxxxxxxxxxxxxx.api.gcp-us-west1.zillizcloud.com",
        "privateLinkAddress": "",
        "createTime": "2024-04-01T06:32:39Z",
        "storageSize": 0,
        "snapshotNumber": 0,
        "createProgress": 100,
        "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxx"
    }
}



## Request

### Parameters

- No query parameters required

- Path parameters

    | Parameter        | Description                                                                               |
    |------------------|-------------------------------------------------------------------------------------------|
    | __CLUSTER_ID__  | **string**(required)<br/>|

- Header parameters

    | Parameter        | Description                                                                               |
    |------------------|-------------------------------------------------------------------------------------------|
    | __Authorization__  | **string**<br/>|

### Request Body

No request body required

## Response

Returns an array of clusters in detail.

### Response Body

```json
{
    "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"
    }
}

Property	Description
code	integer Indicates whether the request succeeds. 0: The request succeeds. Others: Some error occurs.
data	object
data.clusterId	string The ID of the cluster.
data.clusterName	string The Name of the cluster.
data.description	string An optional description of the cluster.
data.regionId	string The ID of the cloud region where the cluster exists.
data.clusterType	string The type of the CU associated with the cluster.
data.cuSize	integer The size of the CU used by the cluster.
data.status	string The current status of the cluster. Possible values are CREATING, RUNNING, SUSPENDING, and RESUMING.
data.connectAddress	string The public endpoint of the cluster. You can use this to connect to your cluster from public networks.
data.privateLinkAddress	string The private endpoint of the cluster. You can use this to connect to your cluster from your VPSs in the same cloud region.
data.createTime	string The time when this cluster has been creaated.
data.storageSize	integer (sint64) The storage size of the cluster.
data.snapshotNumber	integer The number of snapshofts created from the cluster.
data.createProgress	integer The creation progress of the cluster.

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.