跳到主要内容

查看索引列表

This operation lists all indexes of a specific collection.

POST
/v2/vectordb/indexes/list
集群 Endpoint

该 API 的 Base URL 格式如下:

https://${CLUSTER_ENDPOINT}

📘说明
export CLUSTER_ENDPOINT=""
参数
Authorizationstringheaderrequired

认证令牌。应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码,如 username:password

示例值:Bearer {{TOKEN}}
请求体application/json
collectionNamestring必填项

现有 Collection 的名称。设置为一个不存在的 Collection 时会导致报错。

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/indexes/list" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
"collectionName": "test_collection"
}'
响应200 - application/json

A success response.

codeinteger

响应码。

示例值:0
dataarray

响应载荷,为所有索引名称列表。

[]datastring

索引名称。

A failure response.

codeinteger

响应码。

messagestring

错误描述。

{
"code": 0,
"data": [
"my_vector_index"
]
}