Cluster を一時停止 (V1)

ノート

指定した cluster を一時停止します。この操作では cluster のみが停止され、データはそのまま保持されます。

POST/v1/clusters/{CLUSTER_ID}/suspend

接続エンドポイント

https://controller.api.${CLOUD_REGION}.zillizcloud.com

📘ノート

• ${CLOUD_REGION} を、デプロイに適したリージョンに置き換える必要があります。
• クラウドリージョンIDを取得するには、Zilliz Cloudコンソールまたはクラウドリージョンの一覧を参照してください。

shell

export CLOUD_REGION="gcp-us-west1"
export BASE_URL="https://controller.api.${CLOUD_REGION}.zillizcloud.com"

パラメータ

Authorizationstringheader必要

認証トークンは、適切な権限を持つ API key である必要があります。

値の例： Bearer {{TOKEN}}

CLUSTER_IDstringpath必要

一時停止する cluster の ID。

値の例： {{CLUSTER_ID}}

bash

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 "Request-Timeout: 5" \
--header "Content-Type: application/json"

レスポンス200 OK - application/json

影響を受けた cluster の ID を返します。

Success

成功レスポンス。

codeinteger

レスポンスコード。

dataobject

cluster の ID を含むオブジェクトであるレスポンスペイロード。

clusterIdstring

cluster の ID。

promptstring

現在の操作が成功したことを示す文言。

Failure

エラーメッセージを返します。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson

{
    "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."
    }
}