跳到主要内容

查看集群详情 (V2)

Describe a cluster in detail.

GET
/v2/clusters/{CLUSTER_ID}
Base URL

该 API 的 Base URL 格式如下：

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

📘说明

控制面接口速率限制为单用户单接口每秒最多 20 个请求。

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

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

示例值：Bearer {{TOKEN}}
Acceptstringheader

使用 application/json。

示例值：application/json
CLUSTER_IDstringpathrequired

待查询集群的 ID。

示例值：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

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

planstring

集群所在项目的订阅计划。当前支持 Free、 Serverless 和 Enterprise 计划。

statusstring

当前集群的状态。

connectAddressstring

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

privateLinkAddressstring

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

replicastring

当前集群的副本数量。

cuSizeinteger

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

取值范围：0≤ 256
storageSizeinteger

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

snapshotNumberinteger

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

createProgressinteger

当前集群的创建进度。

createTimestring

当前集群的创建时间。

deploymentOptionstring

当前集群部署方式。

autoscalingobject

集群的自动扩缩容配置。

cuobject

CU 的自动扩缩容配置。

mininteger

自动扩缩容的最小 CU 数量。此参数与 schedules 互斥。

取值范围：> 1≤ 256
maxinteger

自动扩缩容的最大 CU 数量。此参数与 schedules 互斥。

取值范围：> 1≤ 256
schedulesarray

自动扩缩容的时间表。此参数与 min/max 互斥。

[]schedulesobject

自动扩缩容时间表。

cronstring

定义时间表的 Cron 表达式。

示例值：0 0 * * *
targetinteger

此时间表的目标 CU 数量。

replicaobject

Replica 的自动扩缩容配置。

mininteger

自动扩缩容的最小 Replica 数量。此参数与 schedules 互斥。

取值范围：> 1≤ 10
maxinteger

自动扩缩容的最大 Replica 数量。此参数与 schedules 互斥。

取值范围：> 1≤ 10
schedulesarray

自动扩缩容的时间表。此参数与 min/max 互斥。

[]schedulesobject

自动扩缩容时间表。

cronstring

定义时间表的 Cron 表达式。

示例值：0 0 * * *
targetinteger

此时间表的目标 Replica 数量。

返回错误消息。

codeinteger

响应码。

messagestring

错误描述。

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