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

コレクションの一覧表示 (V2)

この操作は、現在の接続のすべてのコレクション名を一覧表示します。

POST/v2/vectordb/collections/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キー、またはコロンで連結したユーザー名とパスワードのペア（例: username:password）である必要があります。

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

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

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

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

この操作は、現在の接続で使用されているデータベース内のすべてのコレクションを一覧表示します。

codeinteger

応答コード。

dataarray

コレクション名のリストである応答ペイロード。

[]datastring

コレクション名。

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

codeinteger

応答コード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": [
        "quick_setup_new",
        "customized_setup_1",
        "customized_setup_2"
    ]
}
Ctrl I