HTTP API を使用したコレクション統計の取得 - DashVector

コレクションの統計情報 (総ドキュメント数、インデックスの完全性、パーティションごとの内訳など) を取得します。

前提条件

開始する前に、以下が準備できていることを確認してください。

リクエスト構文

GET https://{Endpoint}/v1/collections/{CollectionName}/stats

リクエストパラメーター

パラメーター	場所	型	必須	説明
`{Endpoint}`	パス	文字列	はい	クラスターのエンドポイント。コンソールのクラスターの詳細ページで確認できます。
`{CollectionName}`	パス	文字列	はい	クエリ対象のコレクションの名前。
`dashvector-auth-token`	ヘッダー	文字列	はい	認証用の API キー。

例

<your-api-key> をお使いの API キーに、<your-cluster-endpoint> をお使いのクラスターエンドポイントに置き換えてください。

この例では、quickstart という名前のコレクションの統計情報をクエリします。このコレクションを作成するには、「コレクションの作成」の例をご参照ください。

curl -H 'dashvector-auth-token: <your-api-key>' \
  https://<your-cluster-endpoint>/v1/collections/quickstart/stats

レスポンスの例：

{
  "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"
      }
    }
  }
}

レスポンスの主要なフィールド：

total_doc_count：すべてのパーティションにわたるドキュメントの総数。
index_completeness：コレクションのインデックスの完全性。
partitions：ドキュメント数のパーティションごとの内訳。

レスポンスパラメーター

パラメーター	型	説明	例
`code`	整数	ステータスコード。`0` は成功を示します。その他のコードについては、「ステータスコード」をご参照ください。	`0`
`message`	文字列	レスポンスメッセージ。	`success`
`request_id`	文字列	トラブルシューティング用の一意なリクエスト識別子。	`19215409-ea66-4db9-8764-26ce2eb5bb99`
`output`	オブジェクト	コレクションの統計情報。完全なスキーマについては、「CollectionStats」をご参照ください。	--