Describe Index
This operation describes the current index.
The base URL for this API is in the following format:
http://localhost:19530
export CLUSTER_ENDPOINT="http://localhost:19530"
The authentication token should be a pair of colon-joined username and password, like username:password
.
The name of the database to which the collection belongs.
The name of the collection to which the index belongs.
The name of the index to describe.
export TOKEN="root:Milvus"
curl --request POST \--url "${CLUSTER_ENDPOINT}/v2/vectordb/indexes/describe" \--header "Authorization: Bearer ${TOKEN}" \--header "Content-Type: application/json" \-d '{ "indexName": "vector", "collectionName": "quick_setup"}'
A success response.
Response code.
Response payload which is detailed information about the index.
The name of the target field.
The name of the index.
The status of the indexing progress.
The type of this index.
The total number of entities/rows that have been indexed.
The type of the similarity metric.
The number of entities/rows that are waiting to be indexed.
The total number of entities/rows.
The reason for the failure to build indexes.
A failure response.
Response code.
Error message.
{ "code": 0, "data": [ { "failReason": "", "fieldName": "vector", "indexName": "vector", "indexState": "Finished", "indexType": "", "indexedRows": 0, "metricType": "COSINE", "pendingRows": 0, "totalRows": 0 } ]}