milvus-logo
LFAI
< Docs
  • RESTful
    • v2

Drop Alias

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

This operation drops a specified alias.

Example

export MILVUS_URI="localhost:19530"

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

Possible response is similar to the following

{
    "code": 0,
    "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.
collectionNamestring
The name of the collection to which the alias is assigned to.
aliasName *string
The alias to drop.
When dropping an alias, you do not need to provide the collection name because one alias can only be assigned to exactly one collection. Therefore, the server knows which collection the specified alias belongs to.

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.
messagestring
Indicates the possible reason for the reported error.
dataobject