挂起集群

本接口可以暂停指定集群。

POST

/v2/clusters/{CLUSTER_ID}/suspend

Base URL

该 API 的 Base URL 格式如下：

https://api.cloud.zilliz.com.cn

📘说明

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

export BASE_URL="https://api.cloud.zilliz.com.cn"

参数

Authorizationstringheaderrequired

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

示例值：Bearer {{TOKEN}}

Acceptstringheader

使用 application/json。

示例值：application/json

CLUSTER_IDstringpathrequired

ID of the cluster to suspend.

示例值：inxx-xxxxxxxxxxxxxxx

export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"

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

响应200 - application/json

SUCCESS

codeinteger

响应码。

dataobject

响应负载。

clusterIdstring

已暂停集群的 ID。

promptstring

返回的提示信息。

FAILURE

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "code": 0,
    "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."
    }
}