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

インデックスを一覧表示 (V2)

この操作は、特定のコレクションのすべてのインデックスを一覧表示します。

POST/v2/vectordb/indexes/list
接続エンドポイント

https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

📘ノート
  • サービングクラスターを使用している場合は、クラスターエンドポイントを使用してください。

    • Free & Serverless

      https://{cluster-id}.serverless.{region}.vectordb.zillizcloud.com

    • Dedicated

      https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

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

認証トークンには、適切な権限を持つ API key、または username:password のようにコロンで連結された username と password の組み合わせを指定する必要があります。project endpoint を使用している場合は、十分な権限を持つ有効な API key のみ使用できます。

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

コレクションが属するデータベースの名前。

collectionNamestring必要

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

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

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

構築済みのすべてのインデックス名を含むオブジェクト。

成功レスポンス。

codeinteger

レスポンスコード。

値の例： 0
dataarray

インデックスの一覧であるレスポンスペイロード。

[]datastring

インデックス名。

失敗レスポンス。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": [
        "my_vector_index"
    ]
}
Ctrl I