Alter Alias
This operation reassigns the alias of one collection to another.
POST
/v2/vectordb/aliases/alterThe base URL for this API is in the following format:
http://localhost:19530
export CLUSTER_ENDPOINT="http://localhost:19530"
Parameters
Request-Timeoutintegerheader
The timeout duration for this operation in seconds. Setting this to None indicates that this operation timeouts when any response arrives or any error occurs.
Example Value: 0
Authorizationstringheaderrequired
The authentication token should be a pair of colon-joined username and password, like username:password
.
Example Value: Bearer {{TOKEN}}
Request Bodyapplication/json
dbNamestring
The name of the database to which the collection belongs.
collectionNamestringrequired
The name of the target collection to reassign an alias to.
aliasNamestringrequired
The alias of the collection.
export TOKEN="root:Milvus"
curl --request POST \--url "${CLUSTER_ENDPOINT}/v2/vectordb/aliases/alter" \--header "Request-Timeout: 0" \--header "Authorization: Bearer ${TOKEN}" \--header "Content-Type: application/json" \-d '{ "aliasName": "bob", "collectionName": "custom_setup_indexed"}'
Responses200 - application/json
A success response
codeinteger
Response code.
Example Value: 0
dataobject
Response payload which is an empty object.
Returns an error message.
codeinteger
Response code.
messagestring
Error message.
{ "code": 0, "data": {}}