milvus-logo
LFAI
< Docs
  • RESTful
    • About
    • v2

Describe Alias

This operation describes the details of a specific alias.

POST
/v2/vectordb/aliases/describe
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 the database to which the alias belongs.

aliasNamestringrequired

The name of the alias whose details are to be listed.

export TOKEN="root:Milvus"


curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/aliases/describe" \
--header "Request-Timeout: 0" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "aliasName": "alice"
}'
Responses200 - application/json
codeinteger

Response code.

Example Value: 0
dataobject

Response payload which carries the detailed description of an alias.

dbNamestring

The name of the database to which the collection belongs.

collectionNamestring

the name of the collection to which an alias belongs.

aliasNamestring

The name of the alias.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 0,
    "data": {
        "aliasName": "alice",
        "collectionName": "quick_setup",
        "dbName": "default"
    }
}