milvus-logo
LFAI
< Docs
  • RESTful
    • v2

Create Alias

POST
http://${MILVUS_URI}/v2/vectordb/aliases/create

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.

Example

export MILVUS_URI="localhost:19530"

curl --location --request POST "http://${MILVUS_URI}/v2/vectordb/aliases/create" \
--header "Content-Type: application/json" \
--data-raw '{
    "aliasName": "bob",
    "collectionName": "quick_setup"
}'

Possible response is similar to the following

{
    "code": 200,
    "data": {}
}

Request

Parameters

  • Header parameters

    ParameterDescription
    Request-Timeoutinteger
    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.
    Authorizationstring
    The authentication token.
  • No query parameters required

  • No path parameters required

Request Body

{
    "dbName": "string",
    "collectionName": "string",
    "aliasName": "string"
}
ParameterDescription
dbNamestring
The name of the database to which the collection belongs.
collectionName *string
The name of the target collection to reassign an alias to.
aliasName *string
The alias of the collection.

Response

None

Response Bodies

  • Response body if we process your request successfully
{
    "code": "integer",
    "data": {}
}
  • Response body if we failed to process your request
{
    "code": integer,
    "message": string
}

Properties

The properties in the returned response are listed in the following table.

PropertyDescription
codeinteger
Indicates whether the request succeeds.
  • 200: The request succeeds.
  • Others: Some error occurs.
dataobject
messagestring
Indicates the possible reason for the reported error.