统计Partition

本文介绍如何通过HTTP API获取Collection中一个已存在的Partition的统计信息,如Doc数等。

前提条件

Method与URL

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

使用示例

说明
  1. 需要使用您的api-key替换示例中的YOUR_API_KEY、您的Cluster Endpoint替换示例中的YOUR_CLUSTER_ENDPOINT,代码才能正常运行。

  2. 本示例需要参考新建Collection-使用示例提前创建好名称为quickstart的Collection

  3. 本示例需要参考新建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

参考PartitionStats