milvus-logo
LFAI
< Docs
  • RESTful
    • v2

List Aliases

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

POST
/v2/vectordb/aliases/list
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. Setting this to None indicates that this operation times out when any response returns or an 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 an existing database.

collectionNamestring

The name of an existing collection. If specified, only returns aliases of the specified collection. If not specified, returns aliases of all collections in the database.

export TOKEN="root:Milvus"
curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/aliases/list" \
--header "Request-Timeout: 0" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
"dbName": "default"
}'
Responses200 - application/json
codeinteger

Response code.

Example Value: 0
dataarray

Response payload which is a list of item objects.

[]datastring

A list of item objects.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

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