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

Get コレクション Load State (V2)

この操作は、特定のコレクションのロード状態を返します。

POST/v2/vectordb/collections/get_load_state
接続エンドポイント

https://${CLUSTER_ENDPOINT}

📘ノート
  • ${CLUSTER_ENDPOINT} を、あなたのZilliz Cloudクラスターのエンドポイントに置き換える必要があります。
  • エンドポイントを取得するには、Describe Cluster V2 APIを使用してレスポンスから値を抽出してください。
shell
export CLUSTER_ENDPOINT=""
パラメータ
Authorizationstringheader必要

認証トークンは、適切な権限を持つ API キー、または コロンで区切られたユーザー名とパスワードのペア（例: username:password）である必要があります。プロジェクトエンドポイントを使用する場合は、十分な権限を持つ有効な API キーのみが使用できます。

値の例： Bearer {{TOKEN}}
リクエスト・ボディapplication/json
dbNamestring

コレクションが属するデータベースの名前。存在しないデータベースを指定するとエラーになります。指定しない場合は、デフォルトのデータベースが使用されます。

collectionNamestring必要

対象コレクションの名前。 存在しないコレクションを指定するとエラーになります。

partitionNamesarray

パーティション名のリスト。パーティション名を指定した場合、そのいずれかのパーティションをリリースすると、NotLoad 状態が返されます。

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/get_load_state" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "quick_setup"
}'
レスポンス200 OK - application/json

指定したコレクションのロード状態を示す LoadState オブジェクト。

codeinteger

レスポンスコード。

値の例： 0
dataobject

指定したコレクションのロード状態とロード進行状況を示す LoadState オブジェクト。

loadStatestring

指定したコレクションのロード状態を示すオブジェクト。

loadProgressinteger

指定したコレクションのロード進行状況をパーセンテージで示す整数。

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": {
        "loadProgress": 100,
        "loadState": "LoadStateLoaded",
        "message": ""
    }
}
Ctrl I