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

Collection の有無確認 (V2)

この操作では、collection が存在するかどうかを確認します。

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

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

collection が属する database の名前です。存在しない database に設定するとエラーになります。指定しない場合は、default database が適用されます。

collectionNamestring必要

対象の collection の名前です。 存在しない collection に設定するとエラーになります。

partitionNamesarray

この操作の対象となる partition の名前。指定すると操作範囲がこれらの partition に限定され、指定しない場合は Collection 全体が対象になります。

[]partitionNamesstring

この操作の対象となる partition の名前。partition を指定すると操作範囲がそれらに限定され、指定しない場合は Collection 全体が対象になります。

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

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

指定した collection が存在するかどうかを示す boolean 値です。

指定した Collection が存在するかどうかを示すレスポンスボディ。

codeinteger

レスポンスコード。

値の例： 0
dataobject

boolean 値を含むレスポンスペイロードです。

hasboolean

指定した collection が存在するかどうかを示す boolean 値です。

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": {
        "has": true
    }
}
Ctrl I