跳到主要内容

查看全球集群 (V2)

返回全球集群的基础拓扑和连接信息。本接口不返回复制延迟。

GET/v2/globalClusters/{globalClusterId}
连接端点

该 API 的 Base URL 格式如下:

https://api.cloud.zilliz.com

📘说明

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

shell
export BASE_URL="https://api.cloud.zilliz.com"
参数
Authorizationstringheader必填项

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

示例值:Bearer {{TOKEN}}
globalClusterIdstringpath必填项

要查看的全球集群 ID。

示例值:glo-xxxxxxxxxxxxxxx
bash
export TOKEN="YOUR_API_KEY"
export globalClusterId="glo-xxxxxxxxxxxxxxx"

curl --request GET \
--url "${BASE_URL}/v2/globalClusters/${globalClusterId}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json"
响应

返回全球集群信息。

查询单个 Global Cluster 成功时返回的响应载荷之一。

globalClusterIdstring

全球集群 ID。

示例值:glo-xxxxxxxxxxxxxxx
globalClusterNamestring

全球集群显示名称。

示例值:my-global-cluster
projectIdstring

项目 ID。

示例值:proj-xxxxxxxxxxxxxxx
regionIdsarray

成员集群的区域 ID。取值保留成员顺序且不会去重。

[]regionIdsstring

与 Global Cluster 关联的一个区域 ID。

示例值:aws-us-west-2
cuTypestring

成员集群共享的 CU 类型。

示例值:Performance-optimized
cuSizeinteger

成员集群共享的 CU 大小。

示例值:4
connectAddressstring

全球端点地址。

示例值:https://glo-xxxxxxxx.global-cluster.vectordb.zilliz.com.cn
createTimestring<date-time>

ISO 8601 格式的创建时间。

示例值:2026-06-04T10:00:00Z
clustersarray

全球集群中的成员集群。

[]clustersobject

Global Cluster 中的一个成员集群。

clusterIdstring

成员集群 ID。

示例值:in01-xxxxxxxxxxxxxxx
clusterNamestring

成员集群名称。

示例值:primary-cluster
regionIdstring

成员集群部署的区域 ID。

示例值:aws-us-west-2
rolestring

成员角色。

示例值:PRIMARY
statusstring

成员集群状态。

示例值:RUNNING
dataobject

响应负载,类型随端点而变化。

globalClusterIdstring

全球集群的 ID。

globalClusterNamestring

全球集群的名称。

projectIdstring

全球集群所属项目的 ID。

regionIdsarray

全球集群覆盖的地域的 ID 列表。

[]regionIdsstring

与全局 Cluster 关联的某个区域的标识符。

cuTypestring

全球集群的 CU 类型。

cuSizeinteger<int64>

全球集群的 CU 规格。

autoscalingobject

全球集群的自动扩缩容配置。

cuobject

CU 自动扩缩容的范围与定时计划。

mininteger<int64>

CU 的最小数量。

maxinteger<int64>

CU 的最大数量。

schedulesarray

CU 的定时扩缩容目标列表。

[]schedulesobject

定时扩缩容规则。

cronstring

定义定时计划生效时间的 Cron 表达式。

targetinteger<int64>

定时计划触发时应用的目标值。

timezonestring

Cron 定时计划使用的时区。

replicaobject

副本自动扩缩容的范围与定时计划。

mininteger<int64>

副本的最小数量。

maxinteger<int64>

副本的最大数量。

schedulesarray

副本的定时扩缩容目标列表。

[]schedulesobject

定时扩缩容规则。

cronstring

定义定时计划生效时间的 Cron 表达式。

targetinteger<int64>

定时计划触发时应用的目标值。

timezonestring

Cron 定时计划使用的时区。

connectAddressstring

全球集群的连接地址。

createTimestring<date-time>

全球集群的创建时间。

clustersarray

全球集群的成员集群列表。

[]clustersobject

全球集群的一个成员集群。

clusterIdstring

成员集群的 ID。

clusterNamestring

成员集群的名称。

regionIdstring

成员集群所在地域的 ID。

rolestring

成员集群的角色,例如主集群或备集群。

statusstring

成员集群的状态。

replicainteger<int64>

成员集群的副本数量。

返回错误消息。

codeinteger<int32>

响应码。

示例值:400
messagestring

错误描述。

示例值:Invalid request parameters.
Successjson
{
"globalClusterId": "glo-xxxxxxxxxxxxxxx",
"globalClusterName": "my-global-cluster",
"projectId": "proj-xxxxxxxxxxxxxxx",
"regionIds": [
"ali-cn-hangzhou",
"ali-cn-beijing"
],
"cuType": "Performance-optimized",
"cuSize": 4,
"connectAddress": "https://glo-xxxxxxxx.global-cluster.vectordb.cloud.zilliz.com.cn",
"createTime": "2026-06-04T10:00:00Z",
"clusters": [
{
"clusterId": "in01-primary",
"clusterName": "primary-cluster",
"regionId": "ali-cn-hangzhou",
"role": "PRIMARY",
"status": "RUNNING"
},
{
"clusterId": "in01-secondary",
"clusterName": "secondary-cluster",
"regionId": "ali-cn-beijing",
"role": "SECONDARY",
"status": "RUNNING"
}
]
}