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

Get (V2)

この操作は、IDを指定して特定のエンティティを取得します。

POST/v2/vectordb/entities/get
接続エンドポイント

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）である必要があります。プロジェクトエンドポイントを使用する場合は、十分な権限を持つ有効なAPIキーのみが適用されます。

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

データベースの名前です。

collectionNamestring必要

この操作の対象となるコレクションの名前です。

idobject必要

特定のエンティティID、またはエンティティIDのリストです。

outputFieldsarray

クエリ結果とともに返すフィールドの配列です。

[]outputFieldsstring

出力フィールド名です。

partitionNamesarray

この操作の対象となるパーティションの名前です。

[]partitionNamesstring

パーティション名です。

consistencyLevelstring

この操作の一貫性レベルです。デフォルト値は Bounded です。

partitionNamestring

エンティティを取得するパーティションの名前です。

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/entities/get" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "quick_setup",
    "id": [
        1,
        3,
        5
    ],
    "outputFields": [
        "color"
    ]
}'
レスポンス200 OK - application/json

クエリ結果を返します。

codeinteger

レスポンスコードです。

costinteger

この操作のコストです。 これは、Free クラスターと Serverless クラスターにのみ適用され、現在のリクエストの vCU 使用量を示します。

dataarray

クエリ結果です。

[]dataobject

エンティティオブジェクトです。

scanned_remote_bytesinteger

デプロイメントが使用状況トラッキングを有効にした階層型ストレージを使用し、操作がリモート/diskストレージから読み取る場合に返されます。すべてのデータがローカルキャッシュから提供される場合は省略されます。

scanned_total_bytesinteger

デプロイメントが使用状況トラッキングを有効にした階層型ストレージを使用し、操作がリモート/diskストレージから読み取る場合に返されます。すべてのデータがローカルキャッシュから提供される場合は省略されます。

cache_hit_rationumber

デプロイメントが使用状況トラッキングを有効にした階層型ストレージを使用し、操作がリモート/diskストレージから読み取る場合に返されます。すべてのデータがローカルキャッシュから提供される場合は省略されます。

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

codeinteger

レスポンスコードです。

messagestring

エラーメッセージです。

Successjson
{
    "code": 0,
    "data": [
        {
            "color": "red_7025",
            "id": 1
        },
        {
            "color": "pink_9298",
            "id": 3
        },
        {
            "color": "yellow_4222",
            "id": 5
        }
    ]
}
Ctrl I