如何通过HTTP API获取所有已创建的Collection名称列表_向量检索服务(VRS)-阿里云帮助中心

本文介绍如何通过HTTP API获取所有已创建的Collection名称列表。

前提条件

已创建Cluster：创建Cluster。
已获得API-KEY：API-KEY管理。

Method与URL

HTTP

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

使用示例

说明

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

Shell

curl -H 'dashvector-auth-token: YOUR_API_KEY' \
 https://YOUR_CLUSTER_ENDPOINT/v1/collections

# example output:
# {
#   "request_id": "89557fca-50ca-400d-9828-a6c9ba5a4228",
#   "code": 0,
#   "message": "",
#   "output": [
#     "quickstart",
#   ]
# }

入参描述

参数	Location	类型	必填	说明
{Endpoint}	path	str	是	Cluster的Endpoint，可在控制台Cluster详情中查看
dashvector-auth-token	header	str	是	api-key

出参描述

字段	类型	描述	示例
code	int	返回值，参考返回状态码说明	0
message	str	返回消息	success
request_id	str	请求唯一id
output	array	所有Collection名称列表	['my_collection1', 'my_collection2']