挂起集群

Suspends a specified cluster. This operation will only stop the cluster and your data will remain intact.

POST

/v1/clusters/{CLUSTER_ID}/suspend

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}}

CLUSTER_IDstringpathrequired

The ID of the cluster to suspend.

示例值：{{CLUSTER_ID}}

export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="{{CLUSTER_ID}}"

curl --request POST \
--url "${BASE_URL}/v1/clusters/${CLUSTER_ID}/suspend" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"

响应200 - application/json

SUCCESS

A success response.

codeinteger

响应码。

dataobject

响应载荷，包含已操作集群的 ID。

clusterIdstring

集群 ID。

promptstring

提示信息，表示当前操作成功。

FAILURE

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "code": 200,
    "data": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "prompt": "successfully Submitted. The cluster will not incur any computing costs when suspended. You will only be billed for the storage costs during this time."
    }
}