milvus-logo
LFAI
< Docs
  • RESTful
    • v2
      • Index (v2)

Describe Index

POST
http://${MILVUS_URI}/v2/vectordb/indexes/describe

This operation describes the current index.

Example

export MILVUS_URI="localhost:19530"

curl --location --request POST "http://${MILVUS_URI}/v2/vectordb/indexes/describe" \
--header "Content-Type: application/json" \
--data-raw '{
    "indexName": "vector",
    "collectionName": "quick_setup"
}'

Possible response is similar to the following:

{
    "code": 0,
    "data": [
        {
            "failReason": "",
            "fieldName": "vector",
            "indexName": "vector",
            "indexState": "Finished",
            "indexType": "AUTOINDEX",
            "indexedRows": 0,
            "metricType": "COSINE",
            "pendingRows": 0,
            "totalRows": 0
        }
    ]
}

Request

Parameters

  • Header parameters

    ParameterDescription
    Request-Timeoutinteger
    The timeout duration for this operation.
    Setting this to None indicates that this operation timeouts when any response arrives or any error occurs.
    Authorizationstring
    The authentication token.
  • No query parameters required

  • No path parameters required

Request Body

{
    "dbName": "string",
    "collectionName": "string",
    "indexName": "string"
}
ParameterDescription
dbNamestring
The name of the database to which the collection belongs.
collectionName *string
The name of an the collection to which the index belongs.
indexName *string
The name of the index to describe.

Response

An object that contains the detailed description of the current index.

Response Bodies

  • Response body if we process your request successfully
{
    "code": "integer",
    "data": [
        {
            "fieldName": "string",
            "indexName": "string",
            "indexState": "string",
            "indexType": "string",
            "indexedRows": "integer",
            "metricType": "string",
            "pendingRows": "integer",
            "totalRows": "integer",
            "failReason": "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.

PropertyDescription
codeinteger
Indicates whether the request succeeds.
  • 200: The request succeeds.
  • Others: Some error occurs.
messagestring
Indicates the possible reason for the reported error.
dataarray
data[]object
data[].fieldNamestring
The name of the target field.
data[].indexNamestring
The name of the index.
data[].indexStatestring
The status of the indexing progress.
data[].indexTypestring
The type of this index.
data[].indexedRowsinteger
The total number o rows that have been indexed.
data[].metricTypestring
The type of the metric.
data[].pendingRowsinteger
The number of rows that are waiting to be indexed.
data[].totalRowsinteger
The total number of entities/rows
data[].failReasonstring
The reason for the failure to build indexes.