跳到主要内容

查看集群列表

Lists all clusters in the specified cloud region.

GET
/v1/clusters
Base URL

该 API 的 Base URL 格式如下：

https://controller.api.${CLOUD_REGION}.zilliz.com.cn

📘说明
  • 你需要将 ${CLOUD_REGION} 替换为您的集群所在区域。
  • 获取云区域 ID 请参考 Zilliz Cloud 控制台 或使用查看云区域接口。
export CLOUD_REGION="ali-cn-hangzhou"
export BASE_URL="https://controller.api.${CLOUD_REGION}.zilliz.com.cn"
参数
Authorizationstringheaderrequired

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

示例值：Bearer {{TOKEN}}
pageSizeintegerquery

The number of records to return on each page.

示例值：0
currentintegerquery

The current page number.

示例值：0
export TOKEN="YOUR_API_KEY"

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

Returns a list of clusters.

codeinteger

响应码。

dataobject

响应载荷，包含集群列表。

countinteger

返回的集群总数。

currentPageinteger

当前页码。

pageSizeinteger

每页的集群数。

clustersarray

集群详细信息。

[]clustersobject

A cluster.

clusterIdstring

集群的 ID。

clusterNamestring

集群的名称。

descriptionstring

集群的描述。

regionIdstring

集群的地域 ID。

clusterTypestring

集群的 CU 类型。

planstring

集群所属的订阅计划。

cuSizeinteger

集群的 CU 大小。

statusstring

集群的状态。

connectAddressstring

集群的公网地址。你可以从公网连接到集群。

privateLinkAddressstring

集群的私网地址。你可以设置私有连接，使你的 VPS 同属于同一云区域的用户可以访问你的集群。

projectIdstring

集群所在项目的 ID。

createTimestring

集群的创建时间。

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

{
    "code": 200,
    "data": {
        "count": 2,
        "currentPage": 1,
        "pageSize": 10,
        "clusters": [
            {
                "clusterId": "inxx-xxxxxxxxxxxxxxx",
                "clusterName": "Dedicated-02",
                "description": "",
                "regionId": "gcp-us-west1",
                "clusterType": "Performance-optimized",
                "plan": "Standard",
                "cuSize": 1,
                "status": "RUNNING",
                "connectAddress": "https://inxx-xxxxxxxxxxxxxxx.gcp-us-west1.vectordb.zillizcloud.com:19530",
                "privateLinkAddress": "",
                "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxx",
                "createTime": "2024-07-22T04:28:05Z"
            },
            {
                "clusterId": "inxx-xxxxxxxxxxxxxxx",
                "clusterName": "Dedicated-01",
                "description": "",
                "regionId": "az-westus3",
                "clusterType": "Performance-optimized",
                "plan": "Standard",
                "cuSize": 1,
                "status": "RUNNING",
                "connectAddress": "https://inxx-xxxxxxxxxxxxxxx.az-westus3.vectordb.zillizcloud.com:19530",
                "privateLinkAddress": "",
                "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxx",
                "createTime": "2024-07-22T04:25:36Z"
            }
        ]
    }
}
{
    "code": 200,
    "data": {
        "count": 2,
        "currentPage": 1,
        "pageSize": 10,
        "clusters": [
            {
                "clusterId": "inxx-xxxxxxxxxxxxxxx",
                "clusterName": "Dedicated-02",
                "description": "",
                "regionId": "ali-cn-hangzhou",
                "clusterType": "Performance-optimized",
                "plan": "Standard",
                "cuSize": 1,
                "status": "RUNNING",
                "connectAddress": "https://inxx-xxxxxxxxxxxxxxx.ali-cn-hangzhou.vectordb.zilliz.com.cn:19530",
                "privateLinkAddress": "",
                "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxx",
                "createTime": "2024-07-22T04:28:05Z"
            },
            {
                "clusterId": "inxx-xxxxxxxxxxxxxxx",
                "clusterName": "Dedicated-01",
                "description": "",
                "regionId": "tc-ap-beijing",
                "clusterType": "Performance-optimized",
                "plan": "Standard",
                "cuSize": 1,
                "status": "RUNNING",
                "connectAddress": "https://inxx-xxxxxxxxxxxxxxx.tc-ap-beijing.vectordb.zilliz.com.cn:19530",
                "privateLinkAddress": "",
                "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxx",
                "createTime": "2024-07-22T04:25:36Z"
            }
        ]
    }
}