跳到主要内容

查看按需集群详情 (V2)

公测版

Describe the details of a specific on-demand cluster in the current project.

GET/v2/clusters/onDemandClusters/{CLUSTER_ID}
连接端点

该 API 的 Base URL 格式如下：

https://api.cloud.zilliz.com

📘说明

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

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

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

示例值：Bearer {{TOKEN}}
Acceptstringheader

Use application/json.

示例值：application/json
CLUSTER_IDstringpath必填项

当前操作的目标集群。

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

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

返回指定按需集群的详细情况。

codeinteger

响应码。

dataobject

当前集群的详细情况。

propertiesobject
projectIdstring

项目 ID。

clusterIdstring

集群 ID。

示例值：inxx-xxxxxxxxxxxxxxx
clusterNamestring

集群名称。

descriptionstring

按需集群描述。

regionIdstring

集群所处云地域 ID。

示例值：ali-cn-hangzhou
cuSizeinteger

分配给当前集群的 CU 大小。

statusstring

当前集群所处状态。

endpointstring

访问集群时使用的公共端点。注意对于按需集群来说，该端点是一个项目级别的按需计算端点，项目中的所有按需集群共享该端点。在进行搜索和查询时，请和集群 ID 共同使用。

示例值：https://proj-xxxxxxxxxxxxxxx.aws-us-west-2.zillizcloud.com
privateLinkstring

访问集群时使用的私有端点。若未开启 Private Link。此参数值为空。

createdBystring

集群创建人的邮箱。

createTimestring

集群创建时间，UTC ISO-8601 格式。

autoSuspendinteger

自动挂起空闲时间。如果指定的时间段内无任何请求，集群将自动挂起。该值为一个整数，表示秒数。例如，300 表示 5 分钟。

json
{
    "code": 0,
    "data": {
        "projectId": "proj-xxxxxxxxxxxxxxxxxx",
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "clusterName": "Cluster-01",
        "regionId": "ali-cn-beijing",
        "cuSize": 8,
        "status": "RUNNING",
        "endpoint": "https://proj-xxxxxxxxxxxxxxx.ali-cn-beijing.api.cloud.zilliz.com.cn",
        "privateLink": "",
        "createdBy": "john.doe@zilliz.com",
        "createTime": "2024-04-21T10:15:15Z",
        "autoSuspend": 60
    }
}
json
{
    "code": 21119,
    "message": "The apikey is illegal."
}
Ctrl I