オンデマンドクラスターの管理

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

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

このガイドでは、Zilliz Cloud でオンデマンドクラスターを表示、確認、削除する方法について説明します。

オンデマンドクラスターは、オンデマンド検索ワークロード向けにコンピューティングリソースを提供します。リクエストの受信時に起動し、アイドル状態になると、クラスター作成時に設定された自動サスペンドタイムアウトに基づいてゼロまでスケールダウンします。

オンデマンドクラスターを管理するには、対象プロジェクトの Project Admin である必要があります。ロールと権限の詳細については、プラットフォームユーザーの管理を参照してください。

すべてのオンデマンドクラスターを表示する

この操作により、指定したプロジェクトおよびリージョン内のオンデマンドクラスターを一覧表示できます。

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

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

On-Demand Compute > クラスターに移動します。

オンデマンドクラスターの一覧を確認します。ここにはクラスター名、クラスター ID、ステータス、CU サイズ、エンドポイント、作成者、作成日時が含まれます。

オンデマンドクラスターの詳細を確認する

この操作により、クラスター ID を指定して特定のオンデマンドクラスターの詳細を確認できます。

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

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

On-Demand Compute > クラスターに移動します。

対象のクラスターをクリックすると、詳細が表示されます。

クラスターステータスの理解

オンデマンドクラスターのステータスは、リクエストの状況に応じて自動的に変化します。

ステータス	説明
`RUNNING`	クラスターにアクティブなコンピューティングリソースが割り当てられており、検索やクエリのリクエストを処理できる状態です。
`SUSPENDED`	設定されたアイドルタイムアウト期間を経過し、クラスターがゼロまでスケールダウンした状態です。サスペンド中はコンピューティングコストは発生しません。
`DELETING`	クラスターの削除処理が進行中であり、使用できない状態です。

サスペンド中のオンデマンドクラスターにリクエストが届くと、Zilliz Cloud がワークロード用のコンピューティングリソースを起動します。設定された autoSuspend 期間内にリクエストがない場合、クラスターは再びゼロまでスケールダウンします。

オンデマンドクラスターの名前を変更する

RESTful API を使用する場合

次の例では、クラスター名を変更します。詳細については、Update On-Demand クラスターを参照してください。

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
対象のオンデマンドクラスターに移動します。
2
Actions をクリックし、Rename を選択します。
3
クラスターの新しい名前を入力し、Save をクリックします。

オンデマンドクラスターの説明を編集する

RESTful API を使用する場合

次の例では、クラスターの説明を変更します。詳細については、Update On-Demand クラスターを参照してください。

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
対象のオンデマンドクラスターに移動します。
2
説明にカーソルを合わせ、Edit description アイコンをクリックします。
3
クラスターの新しい説明を入力し、Save をクリックします。

オンデマンドクラスターの変更

オンデマンドクラスターの名前、説明、自動サスペンド設定など、各種設定を変更できます。

RESTful API を使用する場合

既存のオンデマンドクラスターについて、名前、説明、自動サスペンド時間、クエリ CU 数を変更できます。詳細については、Update On-Demand クラスターを参照してください。

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

curl --request PATCH \
     --url "https://${BASE_URL}/v2/clusters/onDemandClusters/in07-7d6ac8697204a6a" \
     --header "Authorization: Bearer ${API_KEY}" \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --data-raw '{
        "autoSuspend": "5m",
        "clusterName": "my-on-demand-updated",
        "description": "Updated on-demand cluster description",
        "cuSize": 32
      }'

以下は出力例です。

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

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

Web コンソールから、既存のオンデマンドクラスターのクラスター名、説明、自動サスペンド時間、クエリ CU 数を変更できます。

keep-warm スケジュールの構成

keep-warm スケジュールは、毎週繰り返される一定の時間帯にオンデマンドクラスターを稼働させ続けます。keep-warm ウィンドウが開始されると、Zilliz Cloud はオンデマンドクラスターがサスペンド状態であれば再開します。ウィンドウ中は Auto Suspend が抑制されます。ウィンドウが終了すると、オンデマンドクラスターは既存の自動サスペンドポリシーに再び従います。

keep-warm スケジュールは Auto Suspend を永続的に無効化するものではなく、keep-warm ウィンドウが終了したときにオンデマンドクラスターを能動的にサスペンドするものでもありません。

Note

keep-warm ウィンドウ中にオンデマンドクラスターをサスペンドするには、先に keep-warm スケジュールを無効化または削除してください。

各オンデマンドクラスターが持てる keep-warm スケジュールは 1 つです。スケジュールには週次ルールを 1 ～ 5 件含めることができます。各ルールは組織のシステムタイムゾーンを使用し、曜日、開始時刻、終了時刻を含みます。

RESTful API を使用する場合

オンデマンドクラスターの keep-warm スケジュールは、作成、更新、表示、有効化、無効化、削除できます。

keep-warm スケジュールの作成または更新

keep-warm スケジュールを作成または更新する場合は、ルールの完全なリストを送信します。Zilliz Cloud は、送信されたルールで既存のルールを 1 回の操作で置き換えます。

次の例では、平日の 09:00 から 18:00 までの keep-warm スケジュールを作成します。

レスポンス例:

keep-warm スケジュールの表示

次の例では、オンデマンドクラスターの keep-warm スケジュールを確認します。

レスポンス例:

スケジュールが構成されていない場合、リクエストは成功し、configured として false を返します。

keep-warm スケジュールの有効化または無効化

keep-warm スケジュールを有効化または無効化するには、ルールセット全体と目的の enabled 値を指定して PUT リクエストを送信します。

Note

スケジュールを無効化しても、構成済みのルールはすべて保持されます。オンデマンドクラスターが keep-warm ウィンドウ内にある場合、Zilliz Cloud は直ちに keep-warm モードを終了します。スケジュールによってオンデマンドクラスターがサスペンドされることはありません。

次の例では、既存の keep-warm スケジュールを無効化します。

レスポンス例:

keep-warm スケジュールの削除

keep-warm スケジュールを削除すると、スケジュールとすべてのルールが削除されます。オンデマンドクラスター、データ、イベント、監査レコードは削除されません。

レスポンス例:

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

EnHUwxZCUhT8hlbvMJRchiAQnfY

対象のオンデマンドクラスターに移動します。

Actions メニューを開き、Manage Keep-warm Schedule をクリックします。

Enable Keep-warm Schedule をオンにします。

Schedule Rules で週次ルールを 1 つ以上追加します。

各ルールについて、繰り返す曜日、開始時刻、終了時刻を構成します。

次回の切り替え時刻を確認します。

Save をクリックします。

クラスターの詳細ページには、keep-warm スケジュールのステータスが On、Off、Not configured、Schedule unavailable のいずれかで表示されます。スケジュールが構成されている場合は、ルール数、システムタイムゾーン、次回の切り替え時刻も表示されます。

オンデマンドクラスターが現在 keep-warm ウィンドウ内にある場合、ページにはプライマリのクラスターステータスの隣に、セカンダリの Keep-warm タグが表示されます。

IF04w32RNhEbr7b8OBUcM8n3nnc

スケジュールを無効化しても、構成済みのルールはすべて保持されます。オンデマンドクラスターが keep-warm ウィンドウ内にある場合、Zilliz Cloud は直ちに keep-warm モードを終了します。スケジュールによってオンデマンドクラスターがサスペンドされることはありません。keep-warm スケジュールを無効化するには、以下に示すように Enable Keep-warm Schedule をオフにして Save をクリックします。

OzydwQkLjhVsoBbckHzciUAbnmc

スケジュールを削除すると、すべてのルールが完全に削除されます。keep-warm スケジュールを削除するには、以下に示すように Delete Schedule をクリックし、操作を確定します。

SBkEwV2bihQXhDbdTlIcnnYknSd

オンデマンドクラスターの削除

Danger

オンデマンドクラスターを削除すると、即座に除去され、復元することはできません。この操作は取り消せません。

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

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

On-Demand Compute > クラスターに移動します。

対象のオンデマンドクラスターを選択します。

クラスターを削除し、操作を確定します。

オンデマンドクラスターを作成するには、オンデマンドクラスターの作成を参照してください。
プロジェクトエンドポイント経由で接続するには、オンデマンド検索への接続を参照してください。

すべてのオンデマンドクラスターを表示する​

RESTful API を使用する場合​

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

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

On-Demand Compute > クラスター に移動します。

オンデマンドクラスターの一覧を確認します。ここにはクラスター名、クラスター ID、ステータス、CU サイズ、エンドポイント、作成者、作成日時が含まれます。

オンデマンドクラスターの詳細を確認する​

RESTful API を使用する場合​

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

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

On-Demand Compute > クラスター に移動します。

対象のクラスターをクリックすると、詳細が表示されます。

クラスターステータスの理解​

オンデマンドクラスターの名前を変更する​

対象のオンデマンドクラスターに移動します。

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

クラスターの新しい名前を入力し、Save をクリックします。

オンデマンドクラスターの説明を編集する​

対象のオンデマンドクラスターに移動します。

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

クラスターの新しい説明を入力し、Save をクリックします。

オンデマンドクラスターの変更​

keep-warm スケジュールの構成​

RESTful API を使用する場合​

keep-warm スケジュールの作成または更新​

keep-warm スケジュールの表示​

keep-warm スケジュールの有効化または無効化​

keep-warm スケジュールの削除​

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

対象のオンデマンドクラスターに移動します。

Actions メニューを開き、Manage Keep-warm Schedule をクリックします。

Enable Keep-warm Schedule をオンにします。

Schedule Rules で週次ルールを 1 つ以上追加します。

各ルールについて、繰り返す曜日、開始時刻、終了時刻を構成します。

次回の切り替え時刻を確認します。

Save をクリックします。

オンデマンドクラスターの削除​

RESTful API を使用する場合​

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

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

On-Demand Compute > クラスター に移動します。

対象のオンデマンドクラスターを選択します。

クラスターを削除し、操作を確定します。

関連トピック​

すべてのオンデマンドクラスターを表示する

RESTful API を使用する場合

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

On-Demand Compute > クラスターに移動します。

オンデマンドクラスターの詳細を確認する

RESTful API を使用する場合

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

On-Demand Compute > クラスターに移動します。

クラスターステータスの理解

オンデマンドクラスターの名前を変更する

オンデマンドクラスターの説明を編集する

オンデマンドクラスターの変更

keep-warm スケジュールの構成

RESTful API を使用する場合

keep-warm スケジュールの作成または更新

keep-warm スケジュールの表示

keep-warm スケジュールの有効化または無効化

keep-warm スケジュールの削除

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

オンデマンドクラスターの削除

RESTful API を使用する場合

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

On-Demand Compute > クラスターに移動します。

関連トピック