本文介紹如何通過HTTP API獲取Collection中一個已存在的Partition的統計信息,如Doc數等。
前提條件
Method與URL
GET https://{Endpoint}/v1/collections/{CollectionName}/partitions/{PartitionName}/stats
使用示例
說明
需要使用您的api-key替換示例中的YOUR_API_KEY、您的Cluster Endpoint替換示例中的YOUR_CLUSTER_ENDPOINT,代碼才能正常運行。
本示例需要參考新建Collection-使用示例提前創建好名稱為
quickstart
的Collection本示例需要參考新建Partition-使用示例提前創建好名稱為
shoes
的Partition
curl -H 'dashvector-auth-token: YOUR_API_KEY' \
https://YOUR_CLUSTER_ENDPOINT/v1/collections/quickstart/partitions/shoes/stats
# example output:
# {
# "request_id": "14448bcb-c9a3-49a8-9152-0de3990bce59",
# "code": 0,
# "message": "Success",
# "output": {
# "total_doc_count": "0"
# }
# }
入參描述
參數 | Location | 類型 | 必填 | 說明 |
{Endpoint} | path | str | 是 | Cluster的Endpoint,可在控制臺Cluster詳情中查看 |
{CollectionName} | path | str | 是 | Collection名稱 |
{PartitionName} | path | str | 是 | Partition名稱 |
dashvector-auth-token | header | str | 是 | api-key |
出參描述
字段 | 類型 | 描述 | 示例 |
code | int | 返回值,參考返回狀態碼說明 | 0 |
message | str | 返回消息 | success |
request_id | str | 請求唯一id | 19215409-ea66-4db9-8764-26ce2eb5bb99 |
output | object |
文檔內容是否對您有幫助?