Clusterを再開 (V1)

ノート

一時停止中のclusterを再開します。

POST/v1/clusters/{CLUSTER_ID}/resume

接続エンドポイント

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}/resume" \
--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. Cluster is being resumed, which is expected to takes several minutes. You can access data about the creation progress and status of your cluster by DescribeCluster API. Once the cluster status is RUNNING, you may access your vector database using the SDK."
    }
}