Describe Alias
This operation describes the details of a specific alias.
The base URL for this API is in the following format:
http://localhost:19530
export CLUSTER_ENDPOINT="http://localhost:19530"
The timeout duration for this operation. Setting this to None indicates that this operation times out when any response returns or an error occurs.
The authentication token should be a pair of colon-joined username and password, like username:password
.
The name of the database to which the alias belongs.
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"}'
Response code.
Response payload which carries the detailed description of an alias.
The name of the database to which the collection belongs.
the name of the collection to which an alias belongs.
The name of the alias.
Returns an error message.
Response code.
Error message.
{ "code": 0, "data": { "aliasName": "alice", "collectionName": "quick_setup", "dbName": "default" }}