查看集群列表
List all clusters scoped to API Key.
GET
/v2/clusters该 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
pageSizeintegerquery
The number of records to include in each response.
示例值:10
currentPageintegerquery
The current page number.
示例值:1
export TOKEN="YOUR_API_KEY"
curl --request GET \
--url "${BASE_URL}/v2/clusters" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Content-Type: application/json"
响应200 - application/json
codeinteger
响应码。
dataarray
响应负载,是一个集群详情列表。
[]dataobject
List of clusters in detail.
clusterIdstring
集群 ID。
clusterNamestring
集群名称。
descriptionstring
集群描述。
regionIdstring
集群所在云地域 ID。
planstring
集群订阅计划。
cuTypestring
集群 CU 类型。 仅适用于 Dedicated 集群。对于免费和无服务器集群,该值为空。
cuSizeinteger
集群 CU 大小。 对于免费和无服务器集群,该值始终为 0。
取值范围:0≤ 256
statusstring
集群当前状态。
connectAddressstring
集群公开访问端点 (Public Endpoint)。
privateLinkAddressstring
集群私有访问端点 (Private Link)。
projectIdstring
集群所属项目 ID。
createTimestring
集群创建时间。
Returns an error message.
codeinteger
响应码。
messagestring
错误描述。
{
"code": 0,
"data": {
"count": 1,
"currentPage": 1,
"pageSize": 10,
"clusters": [
{
"clusterId": "inxx-xxxxxxxxxxxxxxx",
"clusterName": "dedicated-3",
"description": "",
"regionId": "aws-us-west-2",
"plan": "Standard",
"cuType": "Performance-optimized",
"cuSize": 1,
"status": "RUNNING",
"connectAddress": "https://inxx-xxxxxxxxxxxxxxx.aws-us-west-2.vectordb.zillizcloud.com:19530",
"privateLinkAddress": "",
"createTime": "2024-06-30T16:49:50Z",
"projectId": "proj-xxxxxxxxxxxxxxxxxxxxxx"
}
]
}
}