List Aliases

This operation lists all existing collection aliases in the specified database.

export MILVUS_URI="localhost:19530"

curl --location --request POST "http://${MILVUS_URI}/v2/vectordb/aliases/list" \
--header "Content-Type: application/json" \
--data-raw '{
    "dbName": "default"
}‘

Possible response is similar to the following

{
    "code": 200,
    "data": [
        "bob"
    ]
}

Request

Parameters

• Header parameters

  Parameter	Description
  Request-Timeout	integer 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.
  Authorization	string The authentication token.

• No query parameters required

• No path parameters required

Request Body

{
    "dbName": "string"
}

Parameter	Description
dbName	string The name of an existing database. The value defaults to default.

Response

A list of collection aliases.

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.

Property	Description
code	integer Indicates whether the request succeeds. 200: The request succeeds. Others: Some error occurs.
data	array
data[]	string A list of item objects.
message	string Indicates the possible reason for the reported error.