跳到主要内容

修改 Alias

This operation reassigns the alias of one collection to another.

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

该 API 的 Base URL 格式如下:

https://${CLUSTER_ENDPOINT}

📘说明
export CLUSTER_ENDPOINT=""
参数
Authorizationstringheaderrequired

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

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

重新分配后当前别名所指向的 Collection 名称。

aliasNamestring必填项

待重新分配的别名。

export TOKEN="db_admin:xxxxxxxxxxxxx"

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

A success response

codeinteger

响应码。

示例值:0
dataobject

响应载荷。为空对象。

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

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