milvus-logo
LFAI
< Docs
  • RESTful
    • About
    • v2

Create Alias

This operation creates an alias for an existing collection. A collection can have multiple aliases, while an alias can be associated with only one collection.

POST
/v2/vectordb/aliases/create
Cluster Endpoint

The 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 assign the created alias to.

aliasNamestringrequired

The alias of the collection. 

export TOKEN="root:Milvus"


curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/aliases/create" \
--header "Request-Timeout: 0" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "aliasName": "bob",
    "collectionName": "quick_setup"
}'
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": {}
}