このトピックでは、HTTP API を使用して、ドキュメント数など、既存のコレクションに関する統計情報をクエリする方法について説明します。
前提条件
クラスターが作成されていること。詳細については、「クラスターの作成」をご参照ください。
API キーが取得されていること。詳細については、「API キーの管理」をご参照ください。
最新バージョンの SDK がインストールされていること。詳細については、「DashVector SDK のインストール」をご参照ください。
メソッドと URL
GET https://{Endpoint}/v1/collections/{CollectionName}/stats例
コードを正しく実行するには、サンプルコードの YOUR_API_KEY を API キーに、YOUR_CLUSTER_ENDPOINT をクラスターのエンドポイントに置き換える必要があります。
quickstartという名前のコレクションを事前に作成する必要があります。詳細については、「コレクションの作成」トピックの「例」セクションをご参照ください。
curl -H 'dashvector-auth-token: YOUR_API_KEY' \
https://YOUR_CLUSTER_ENDPOINT/v1/collections/quickstart/stats
# example output:
# {
# "request_id": "14448bcb-c9a3-49a8-9152-0de3990bce59",
# "code": 0,
# "message": "Success",
# "output": {
# "total_doc_count": "26",
# "index_completeness": 1.0,
# "partitions": {
# "default": {
# "total_doc_count": "26"
# }
# }
# }
# }リクエストパラメーター
パラメーター | 場所 | タイプ | 必須 | 説明 |
{Endpoint} | パス | str | はい | クラスターのエンドポイント。エンドポイントは、コンソールの クラスターの詳細 ページで確認できます。 |
{CollectionName} | パス | str | はい | 既存のコレクションの名前。 |
dashvector-auth-token | ヘッダー | str | はい | API キー。 |
レスポンスパラメーター
パラメーター | タイプ | 説明 | 例 |
code | int | 返されたステータスコード。詳細については、「ステータスコード」をご参照ください。 | 0 |
message | str | 返されたメッセージ。 | success |
request_id | str | リクエストの一意の ID。 | 19215409-ea66-4db9-8764-26ce2eb5bb99 |
output | object | 詳細については、「CollectionStats」をご参照ください。 |