本文介绍如何通过Python SDK获取所有已创建的Collection名称列表。
前提条件
已创建Cluster:创建Cluster。
已获得API-KEY:API-KEY管理。
已安装最新版SDK:安装DashVector SDK。
接口定义
Client.list() -> DashVectorResponse
使用示例
说明
需要使用您的api-key替换示例中的YOUR_API_KEY、您的Cluster Endpoint替换示例中的YOUR_CLUSTER_ENDPOINT,代码才能正常运行。
import dashvector
client = dashvector.Client(
api_key='YOUR_API_KEY',
endpoint='YOUR_CLUSTER_ENDPOINT'
)
collections = client.list()
# 判断list接口是否成功
if collections:
# 查看所有collections
for collection in collections:
print(collection)
# collections长度
print(len(collections))
# 判断某个collection是否存在
print('YOUR_COLLECTION_NAME' in collections)
else:
# 若获取失败,打印错误信息
print(collections)
入参描述
无
出参描述
说明
返回结果为DashVectorResponse对象,DashVectorResponse对象中可获取本次操作结果信息,如下表所示。
字段 | 类型 | 描述 | 示例 |
code | int | 返回值,参考返回状态码说明 | 0 |
message | str | 返回消息 | success |
request_id | str | 请求唯一id | 19215409-ea66-4db9-8764-26ce2eb5bb99 |
output | list[str] | 所有Collection名称列表 | ['my_collection1', 'my_collection2'] |
文档内容是否对您有帮助?