通过PythonSDK获取Collection中一个已存在的Partition的状态

本文介绍如何通过Python SDK获取Collection中一个已存在的Partition的状态

前提条件

已创建Cluster：创建Cluster。
已获得API-KEY：API-KEY管理。
已安装最新版SDK：安装DashVector SDK。

接口定义

Python

Collection.describe_partition(name: str) -> DashVectorResponse

使用示例

说明

需要使用您的api-key替换示例中的YOUR_API_KEY、您的Cluster Endpoint替换示例中的YOUR_CLUSTER_ENDPOINT，代码才能正常运行。
本示例需要参考新建Collection-使用示例提前创建好名称为quickstart的Collection。
本示例需要参考新建Partition-使用示例提前创建好名称为shoes的Partition。

Python

import dashvector

client = dashvector.Client(
    api_key='YOUR_API_KEY',
    endpoint='YOUR_CLUSTER_ENDPOINT'
)
collection = client.get(name='quickstart')

ret = collection.describe_partition('shoes')

print(ret)
# example output:
# {"request_id":"296267a7-68e2-483a-87e6-5992d85a5806","code":0,"message":"","output":"SERVING"}

入参描述

参数	类型	默认值	说明
name	str	-	Partition名称

出参描述

说明

返回结果为DashVectorResponse对象，DashVectorResponse对象中可获取本次操作结果信息，如下表所示。

字段	类型	描述	示例
code	int	返回值，参考返回状态码说明	0
message	str	返回消息	success
request_id	str	请求唯一id	19215409-ea66-4db9-8764-26ce2eb5bb99
output	str	参考Status