[説明] このページは機械翻訳された日本語版です。内容に誤りがございましたら、報告していただけると助かります。

オンデマンドクラスター

Public Preview

オンデマンドクラスターは、オンデマンドの検索およびクエリワークロードにコンピュートリソースを提供します。リクエストが到着すると起動し、アイドル状態になるとゼロまでスケールダウンするため、バッチ検索、検証、探索、常時稼働のサービスを必要としないワークロードに適しています。

前提条件

オンデマンドクラスターを作成する前に、次の条件を満たしていることを確認してください。

• 対象プロジェクトの Project Admin であること。ロールと権限の詳細については、プロジェクトユーザーの管理を参照してください。
• オンデマンドクラスターを作成するプロジェクトの ID を取得していること。
• プロジェクト内のリソースを管理する権限を持つ API キーを取得していること。
• プロジェクトとオンデマンドクラスターが同じリージョンにあること。現在サポートされているリージョンは aws-us-west-2 と az-eastus です。

制限事項

制限	説明
プロジェクトタイプ	オンデマンドクラスターは Enterprise プロジェクトでのみ利用できます。
リージョン	現在、オンデマンドクラスターを作成できるのは aws-us-west-2 と az-eastus のみです。
権限	オンデマンドクラスターを管理するには、Project Admin である必要があります。
クラスター数	各プロジェクトには最大20個のオンデマンドクラスターを作成できます。
データ量	オンデマンドクラスターは、8 CU ごとに最大 3 TB の生データをクエリできます。この制限を超えるクエリはエラーを返します。

オンデマンドクラスターの作成

Zilliz Cloud コンソールまたは RESTful API を使用してオンデマンドクラスターを作成できます。

RESTful API を使用する場合

次の例では、オンデマンドクラスターを作成します。詳細については、Create On-Demand Cluster (V2)を参照してください。

curl --request POST \
--url "${BASE_URL}/v2/clusters/createOnDemandCluster" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "projectId": "proj-xxxxxxxxxxxxxxxxxxx",
    "regionId": "aws-us-west-2",
    "clusterName": "my-on-demand",
    "cuSize": 8,
    "autoSuspend": 60,
    "description": "A cluster for vector search workloads."
}'

次の表は各パラメータについて説明しています。

パラメータ	説明
projectId	オンデマンドクラスターを作成するプロジェクトの ID。
regionId	オンデマンドクラスターをデプロイするリージョン。リージョンはプロジェクトのリージョンと一致している必要があります。現在は aws-us-west-2 または az-eastus を使用します。
clusterName	作成するオンデマンドクラスターの名前。
cuSize	割り当てるクエリ CU の数。クラスターはワークロードに応じてゼロからこの値まで自動的にスケールします。最小値は 8 CU、最大値は 256 CU で、8 単位で指定します。この値は作成後に変更できません。
autoSuspend	クラスターが自動一時停止するまでのアイドルタイムアウト（秒）。この期間中にリクエストを受信しなかった場合、コンピュートコストの発生を停止するためクラスターが一時停止します。最小値とデフォルト値はいずれも60秒です。
description（任意）	作成するオンデマンドクラスターの説明。最大255文字。

出力例は次のとおりです。

{
    "code": 0,
    "data": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "prompt": "Successfully submitted. The on-demand cluster is being created. Use the Describe On-Demand Cluster API to check its creation progress and status. Once the cluster status is RUNNING, use your API key to access the on-demand cluster."
    }
}

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

1

On-Demand Compute > Clusters をクリックします。

2

+ Cluster をクリックします。

3

クラスター設定を構成します。

次の表は各パラメータについて説明しています。

パラメータ	説明
Cluster Name	作成するクラスターの名前。
Cluster Description	作成するオンデマンドクラスターの説明。最大255文字。
Query CU	割り当てるクエリ CU の数。クラスターはワークロードに応じてゼロからこの値まで自動的にスケールします。リクエストが到着すると指定した CU サイズまで起動し、アイドル時にはゼロまでスケールダウンします。 最小値は 8 CU、最大値は 256 CU で、8 単位（8、16、24 など）で指定します。8 CU を超えるクラスターには支払い方法の登録が必要です。 8 に設定すると、最大 3 TB のデータを検索できます。データ量を増やすには CU サイズを増やしてください。 この値は作成後に変更できません。
Auto suspend	クラスターが自動一時停止するまでのアイドル時間（秒）。デフォルトは1分です。この期間中にリクエストを受信しなかった場合、コンピュートコストの発生を停止するためクラスターが一時停止します。

4

Create をクリックします。

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

オンデマンドクラスターの名前、説明、および autoSuspend 設定を更新できます。

RESTful API を使用する場合

次の例では、オンデマンドクラスターを更新します。詳細については、Update On-Demand Cluster (V2)を参照してください。

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"
}'

出力例は次のとおりです。

{
    "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 コンソールを使用する場合

Web コンソールでは、既存のオンデマンドクラスターの名前、説明、自動一時停止時間を変更できます。

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

RESTful API を使用する場合

すべてのオンデマンドクラスターを一覧表示するには、次のリクエストを使用します。

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

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

出力例は次のとおりです。

{
  "code": 0,
  "data": {
    "count": 2,
    "onDemandClusters": [
      {
        "clusterId": "in07-7d6ac8697204a6a",
        "clusterName": "xxx",
        "regionId": "aws-us-west-2",
        "cuSize": 8,
        "status": "SUSPENDED",
        "endpoint": "https://proj-09ee1f4b1151d5dd1edbc5.aws-us-west-2.vectordb-uat3.zillizcloud.com",
        "privateLink": "",
        "createdBy": "admin@zilliz.com",
        "createTime": 1745396115000
      }
    ]
  }
}

Web コンソールを使用する場合{via-web-console}

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

RESTful API を使用する場合

オンデマンドクラスターの詳細を取得するには、次のリクエストを使用します。

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

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

出力例は次のとおりです。

{
  "code": 0,
  "data": {
    "clusterId": "inxx-xxxxxxxxxxxxxxx",
    "clusterName": "xxx",
    "regionId": "aws-us-west-2",
    "cuSize": 8,
    "status": "RUNNING",
    "endpoint": "https://proj-xxxxxxxxxxxxxxx.aws-us-west-2.vectordb-uat3.zillizcloud.com",
    "privateLink": "",
    "createdBy": "admin@zilliz.com",
    "createTime": 1745396115000
  }
}

Web コンソールを使用する場合{via-web-console}

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

🚧Warning

クラスターを削除すると、直ちに完全に削除され、復元できません。この操作は元に戻せません。

RESTful API を使用する場合

オンデマンドクラスターを削除するには、次のリクエストを使用します。

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

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

出力例は次のとおりです。

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

Web コンソールを使用する場合{via-web-console}