Describe Alias

This operation describes the details of a specific alias.

Example

export MILVUS_URI="localhost:19530"

curl --location --request POST "http://${MILVUS_URI}/v2/vectordb/aliases/describe" \
--header "Content-Type: application/json" \
--data-raw  '{
    "aliasName": "bob"
}'

Possible response is similar to the following

{
    "code": 200,
    "data": {
        "aliasName": "bob",
        "collectionName": "quick_setup",
        "dbName": "default"
    }
}

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",
    "aliasName": "string"
}

Parameter	Description
dbName	string The name of the database to which the collection belongs.
aliasName *	string The name of the alias whose details are to be listed.

Response

An alias object that contains the detailed description of an alias.

Response Bodies

• Response body if we process your request successfully

{
    "code": "integer",
    "data": {
        "dbName": "string",
        "collectionName": "string",
        "aliasName": "string"
    }
}

• 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	object
data.dbName	string The name of the database to which the collection belongs.
data.collectionName	string the name of the collection to which an alias belongs.
data.aliasName	string The name of the alias.
message	string Indicates the possible reason for the reported error.