跳到主要内容

查看集群详情

Describe a cluster in detail.

GET
/v2/clusters/{CLUSTER_ID}
Base URL

该 API 的 Base URL 格式如下：

https://api.cloud.zilliz.com.cn

export BASE_URL="https://api.cloud.zilliz.com.cn"
参数
Authorizationstringheaderrequired

认证令牌，应为具备适当权限的 API 密钥。

示例值：Bearer {{TOKEN}}
Acceptstringheader

使用 application/json。

示例值：application/json
CLUSTER_IDstringpathrequired

ID of the cluster whose details are to return.

示例值：inxx-xxxxxxxxxxxxxxx
export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"

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

响应码。

dataobject

响应负载。

clusterIdstring

指定集群的 ID。

clusterNamestring

集群名称。

projectIdstring

当前集群所属的项目 ID。

descriptionstring

当前集群描述。

regionIdstring

当前集群所在的云地域 ID。

cuTypestring

当前集群的 CU 类型。
仅适用于 Dedicated 集群。对于 Free 和 Serverless 集群，该值为空。

planstring

当前集群的订阅计划。

statusstring

当前集群的状态。

connectAddressstring

当前集群的公共访问端点 (Public Endpoint)。

privateLinkAddressstring

当前集群的私有访问端点 (Private Link)。

cuSizeinteger

当前集群的 CU 大小。对于 Free 和 Serverless 集群，该值始终为 0。

取值范围：0≤ 256
storageSizeinteger

当前集群使用的存储空间大小。

snapshotNumberinteger

为当前集群创建的备份数量。

createProgressinteger

当前集群的创建进度。

createTimestring

当前集群的创建时间。

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

{
    "code": 0,
    "data": {
        "clusterId": "in01-108240180a4faf8",
        "clusterName": "dedicated-test",
        "projectId": "proj-b44a39b0c51cf21791a841",
        "description": "",
        "regionId": "aws-us-west-2",
        "cuType": "Performance-optimized",
        "plan": "Standard",
        "status": "RUNNING",
        "connectAddress": "https://in01-108240180a4faf8.aws-us-west-2.vectordb-uat3.zillizcloud.com:19539",
        "privateLinkAddress": "",
        "createTime": "2024-06-30T16:34:09Z",
        "cuSize": 2,
        "storageSize": 0,
        "snapshotNumber": 0,
        "createProgress": 100
    }
}
{
    "code": 0,
    "data": {
        "clusterId": "in05-991240180a4faf8",
        "clusterName": "Serverless-01",
        "projectId": "proj-b44a39b0c51cf21791a841",
        "description": "",
        "regionId": "gcp-us-west1",
        "cuType": "",
        "plan": "Serverless",
        "status": "RUNNING",
        "connectAddress": "https://in05-991240180a4faf8.gcp-us-west1.cloud.zilliz.com",
        "privateLinkAddress": "",
        "createTime": "2024-06-29T16:35:09Z",
        "cuSize": 0,
        "storageSize": 0,
        "snapshotNumber": 0,
        "createProgress": 100
    }
}
{
    "code": 0,
    "data": {
        "clusterId": "in03-112340180a4faf8",
        "clusterName": "Free-01",
        "projectId": "proj-b44a39b0c51cf21791a841",
        "description": "",
        "regionId": "gcp-us-west1",
        "cuType": "",
        "plan": "Free",
        "status": "RUNNING",
        "connectAddress": "https://in03-112340180a4faf8.api.gcp-us-west1.zillizcloud.com",
        "privateLinkAddress": "",
        "createTime": "2024-06-24T12:35:09Z",
        "cuSize": 0,
        "storageSize": 0,
        "snapshotNumber": 0,
        "createProgress": 100
    }
}