< Docs
  • Java


MilvusClient interface. This method shows the information of the specified index.

R<DescribeIndexResponse> describeIndex(DescribeIndexParam requestParam);


Use the DescribeIndexParam.Builder to construct a DescribeIndexParam object.

import io.milvus.param.DescribeIndexParam;
DescribeIndexParam.Builder builder = DescribeIndexParam.newBuilder();

Methods of DescribeIndexParam.Builder:

Method Description Parameters
withCollectionName(collectionName) Set the collection name. Collection name cannot be empty or null. collectionName: The target collection name.
withIndexName(String indexName) Set the target index name. If no index name is specified, the default index name is empty string which means let the server determine it. indexName: The name of the index.
build() Construct a DescribeIndexParam object. N/A

The can throw the following exceptions:

  • ParamException: error if the parameter is invalid.


This method catches all the exceptions and returns an R<DescribeIndexResponse> object.

  • If the API fails on the server side, it returns the error code and message from the server.

  • If the API fails by RPC exception, it returns R.Status.Unknown and error message of the exception.

  • If the API succeeds, it returns a valid DescribeIndexResponse held by the R template. You can use DescIndexResponseWrapper to get index descriptions easily.


A tool class to encapsulate the DescribeIndexResponse.

import io.milvus.response.DescIndexResponseWrapper;
DescIndexResponseWrapper wrapper = new DescIndexResponseWrapper(descIndexResponse);

Methods of DescIndexResponseWrapper:

Method Description Parameters Returns
Get a list of all index descriptions. (Currently only return one index information) N/A List\
getIndexDescByFieldName(String fieldName)
Get index description by field name. Return null if the field doesn't exist. fieldName: A field name IndexDesc


A tool class to describe an index.

Methods of DescIndexResponseWrapper.IndexDesc

Method Description Returns
getIndexType() Get index type. IndexType
getMetricType() Get metric type. MetricType
getExtraParam() Get index parameters in JSON format. String


import io.milvus.param.*;
import io.milvus.response.DescIndexResponseWrapper;
import io.milvus.grpc.DescribeIndexResponse;

DescribeIndexParam param = DescribeIndexParam.newBuilder()
R<DescribeIndexResponse> response = client.describeIndex(param)
if (response.getStatus() != R.Status.Success.getCode()) {

DescIndexResponseWrapper wrapper = new DescIndexResponseWrapper(response.getData());
for (DescIndexResponseWrapper.IndexDesc desc : wrapper.getIndexDescriptions()) {


Was this page helpful?