メインコンテンツまでスキップ

On-Demand Cluster を管理する

Plan availability

この機能は Enterprise プラン以上でのみ利用できます。

Region availability

この機能は現在、AWS us-west-2 および Azure East US リージョンでのみ利用できます。他のリージョンで on-demand cluster を使用するには、お問い合わせください。

このガイドでは、Zilliz Cloud で on-demand clusters を表示、確認、削除する方法について説明します。

On-demand clusters は、オンデマンド検索ワークロード向けのコンピュートを提供します。リクエストが到着すると起動し、cluster 作成時に設定した auto-suspend タイムアウトに基づいて、アイドル時にはゼロまでスケールダウンします。

On-demand cluster を管理するには、対象プロジェクトの Project Admin である必要があります。ロールと権限の詳細については、プロジェクトユーザーの管理 を参照してください。

すべての on-demand clusters を表示する​

この操作を使用して、プロジェクトおよびリージョン内の on-demand clusters を一覧表示します。

RESTful API を使用する場合​

bash
curl --request GET \
     --url "${BASE_URL}/v2/clusters/onDemandClusters?projectId=proj-xxxxxxxxxxxxxxx&regionId=aws-us-west-2" \
     --header "Authorization: Bearer ${TOKEN}" \
     --header "Accept: application/json"

レスポンス例:

bash
{
    "code": 0,
    "data": {
        "count": 2,
        "onDemandClusters": [
            {
                "projectId": "proj-xxxxxxxxxxxxxxx",
                "clusterId": "inxx-xxxxxxxxxxxxxxx",
                "clusterName": "Cluster-01",
                "regionId": "aws-us-west-2",
                "cuSize": 8,
                "status": "RUNNING",
                "endpoint": "https://proj-xxxxxxxxxxxxxxx.aws-us-west-2.api.zillizcloud.com",
                "privateLink": "",
                "createdBy": "john.doe@zilliz.com",
                "createTime": "2024-04-21T10:15:15Z",
                "autoSuspend": 60,
                "description": "An on-demand cluster for vector search workloads."
            },
            {
                "projectId": "proj-xxxxxxxxxxxxxxx",
                "clusterId": "inxx-xxxxxxxxxxxxxxx",
                "clusterName": "Cluster-02",
                "regionId": "aws-us-west-2",
                "status": "RUNNING",
                "cuSize": 8,
                "endpoint": "https://proj-xxxxxxxxxxxxxxx.aws-us-west-2.api.zillizcloud.com",
                "privateLink": "",
                "createdBy": "john.doe@zilliz.com",
                "createTime": "2024-04-21T10:15:16Z",
                "autoSuspend": 60,
                "description": "An on-demand cluster for vector search workloads."
            }
        ]
    }
}

Web コンソールを使用する場合​

W3nYwPc0AhxRDWbjEsWceJGVnbh

1

Zilliz Cloud コンソールで、対象プロジェクトを開きます。

2

On-Demand Compute > Clusters に移動します。

3

cluster 名、cluster ID、ステータス、CU サイズ、endpoint、作成者、作成時刻を含む on-demand cluster の一覧を確認します。

on-demand cluster の詳細を確認する​

この操作を使用して、cluster ID によって 1 つの on-demand cluster を確認します。

RESTful API を使用する場合​

bash
curl --request GET \
     --url "https://${BASE_URL}/v2/on-demand-compute?projectId=proj-09ee1f4b1151d5dd1edbc5&regionId=aws-us-west-2" \
     --header "Authorization: Bearer ${API_KEY}" \
     --header "Accept: application/json"

レスポンス例:

bash
{
  "code": 0,
  "data": {
    "projectId": "proj-09ee1f4b1151d5dd1edbc5",
    "regionId": "aws-us-west-2",
    "status": "enabled"
  }
}

Web コンソールを使用する場合​

XiWTwTJ3mhgjHBbS5dycYi4bn4c

1

Zilliz Cloud コンソールで、対象プロジェクトを開きます。

2

On-Demand Compute > Clusters に移動します。

3

対象の cluster をクリックして詳細を表示します。

cluster ステータスを理解する​

On-demand cluster は、リクエストのアクティビティに応じて自動的にステータスが変化します。

StatusDescription
RUNNINGcluster はアクティブなコンピュートリソースを持ち、検索またはクエリリクエストを処理できます。
SUSPENDEDcluster は設定されたアイドルタイムアウト後にゼロまでスケールダウンしています。停止中はコンピュートコストが発生しません。
DELETINGcluster は削除中であり、使用できません。

停止中の on-demand cluster にリクエストが到着すると、Zilliz Cloud はそのワークロードのためにコンピュートリソースを起動します。設定された autoSuspend 期間内にリクエストが受信されない場合、cluster は再びゼロまでスケールダウンします。

on-demand cluster の名前を変更する​

  • RESTful API を使用する場合

    以下の例では cluster 名を変更します。詳細については、Update On-Demand Cluster Info を参照してください。

    bash
    curl --request PATCH \
    --url "${BASE_URL}/v2/clusters/onDemandClusters/${CLUSTER_ID}" \
    --header "Authorization: Bearer ${TOKEN}" \
    --header "OrgId: org-xxxxxxxxxxxxxxxxxxx" \
    --header "Content-Type: application/json" \
    -d '{
        "clusterName": "New Cluster Name"
    }'

    以下は出力例です。

    json
    {
        "code": 0,
        "data": {
            "clusterId": "inxx-xxxxxxxxxxxxxxx",
            "prompt": "successfully submitted. Cluster is being upgraded, which is expected to take 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."
        }
    }

  • Web コンソールを使用する場合

    1

    対象の on-demand cluster に移動します。

    2

    Actions をクリックし、Rename を選択します。

    IvU4bhPSfo7u76xC67DcESHpnfg

    3

    cluster の新しい名前を入力し、Save をクリックします。

    GPBzb78W3ojP0HxalhHc6M4Zn6c

on-demand cluster の説明を編集する​

  • RESTful API を使用する場合

    以下の例では cluster の説明を変更します。詳細については、Update On-Demand Cluster Info を参照してください。

    bash
    curl --request PATCH \
    --url "${BASE_URL}/v2/clusters/onDemandClusters/${CLUSTER_ID}" \
    --header "Authorization: Bearer ${TOKEN}" \
    --header "OrgId: org-xxxxxxxxxxxxxxxxxxx" \
    --header "Content-Type: application/json" \
    -d '{
        "description": ""
    }'

    以下は出力例です。

    json
    {
        "code": 0,
        "data": {
            "clusterId": "inxx-xxxxxxxxxxxxxxx",
            "prompt": "successfully submitted. Cluster is being upgraded, which is expected to take 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."
        }
    }

  • Web コンソールを使用する場合

    1

    対象の on-demand cluster に移動します。

    2

    説明にカーソルを合わせて Edit description アイコンをクリックします。

    AbaibGQY5oI7hMx81F9cOBOlnAd

    3

    cluster の新しい説明を入力し、Save をクリックします。

    HKlybJYCFo2uMHxmVZ0cBs7Gnid

on-demand cluster を変更する​

名前、説明、auto-suspend 設定など、on-demand cluster の設定を変更できます。

  • RESTful API を使用する場合

    既存の on-demand cluster の auto-suspend 時間を変更できます。

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

    curl --request PATCH \
    --url "${BASE_URL}/v2/clusters/onDemandClusters/${CLUSTER_ID}" \
    --header "Authorization: Bearer ${TOKEN}" \
    --header "OrgId: org-xxxxxxxxxxxxxxxxxxx" \
    --header "Content-Type: application/json" \
    -d '{
        "clusterName": "New Cluster Name",
        "description": "This is the new description of the cluster.",
        "autoSuspend": "5m"
    }'

    以下は出力例です。

    bash
    {
      "code": 0,
      "data": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "prompt": "Successfully submitted."
      }
    }

  • Web コンソールを使用する場合

    Web コンソールでは、既存の on-demand cluster の cluster 名、説明、auto-suspend 時間を変更できます。

    M2XMwoWoih17BRbqhGhcb6i9njg

on-demand cluster を削除する​

🚧危険

on-demand cluster を削除すると、即座に削除され、復元できません。この操作は元に戻せません。

RESTful API を使用する場合​

bash
curl --request DELETE \
     --url "${BASE_URL}/v2/clusters/onDemandClusters/inxx-xxxxxxxxxxxxxxx" \
     --header "Authorization: Bearer ${TOKEN}" \
     --header "Accept: application/json"

レスポンス例:

bash
{
  "code": 0,
  "data": {
    "clusterId": "inxx-xxxxxxxxxxxxxxx",
    "status": "DELETING"
  }
}

Web コンソールを使用する場合​

H9p9wioiohNX3Ub6evBcWGTBnse

1

Zilliz Cloud コンソールで、対象プロジェクトを開きます。

2

On-Demand Compute > Clusters に移動します。

3

対象の on-demand cluster を選択します。

4

cluster を削除し、操作を確認します。

Ctrl I