Skip to main content

List Aliases

This operation lists all existing collection aliases in the specified Zilliz Cloud cluster.

POST
/v2/vectordb/aliases/list
Cluster Endpoint

The base URL for this API is in the following format:

https://${CLUSTER_ENDPOINT}

📘Notes
  • You need to fill in ${CLUSTER_ENDPOINT} with that of your Zilliz Cloud cluster.
  • To get the endpoint, refer to Zilliz Cloud Console or use the Describe Cluster V2 API to extract the values from the responses.
export CLUSTER_ENDPOINT=""
Parameters
Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges or 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="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/aliases/list" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "value": {
        "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"
    ]
}