跳到主要内容

删除 Alias

This operation drops a specified alias.

POST
/v2/vectordb/aliases/drop
集群 Endpoint

该 API 的 Base URL 格式如下:

https://${CLUSTER_ENDPOINT}

📘说明
export CLUSTER_ENDPOINT=""
参数
Authorizationstringheaderrequired

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

示例值:Bearer {{TOKEN}}
请求体application/json
dbNamestring

数据库名称。

collectionNamestring

分配了指定别名的 Collection 名称。

aliasNamestring必填项

待删除的 Collection 别名。 删除别名时无需提供 Collection 名称,因为一个别名只能分配给一个 Collection。因此,服务器可以确定指定的别名属于哪个 Collection。

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/aliases/drop" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
"aliasName": "bob"
}'
响应200 - application/json

A success response

codeinteger

响应码。

示例值:0
dataobject

响应载荷。为空对象。

codeinteger

响应码。

messagestring

错误描述。

{
"code": 0,
"data": {}
}