全部產品
Search
文件中心

DashVector:擷取Collection列表

更新時間:Jul 13, 2024

本文介紹如何通過HTTP API擷取所有已建立的Collection名稱列表。

前提條件

Method與URL

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

使用樣本

說明

需要使用您的api-key替換樣本中的YOUR_API_KEY、您的Cluster Endpoint替換樣本中的YOUR_CLUSTER_ENDPOINT,代碼才能正常運行。

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']