Describe Collection
Describes the details of a collection.
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 collection to describe.
The name of the database.
export TOKEN="root:Milvus"
curl --request GET \--url "${CLUSTER_ENDPOINT}/v1/vector/collections/describe?collectionName=undefined" \--header "Authorization: Bearer ${TOKEN}" \--header "Content-Type: application/json"
response code.
Response payload which carries the collection details.
The name of the collection.
An optional description of the collection.
An field array
A field object
Whether the primary key automatically increments. This field applies only when the current field is the primary key.
An optional description of the field.
The name of the field.
Whether the field is a primary field.
The data type of the values in this field.
An index array
An index object
The name of the indexed field.
The name of the generated index files.
The metric type used to measure similarity between vectors
The load status of the collection.
The number of shards in the collection.
Whether the dynamic field feature is enabled for this collection.
A failure response.
Response code.
Error message.
{ "code": 200, "data": { "aliases": [], "autoId": false, "collectionID": 448707763883002000, "collectionName": "test_collection", "consistencyLevel": "Bounded", "description": "", "enableDynamicField": true, "fields": [ { "autoId": false, "description": "", "id": 100, "name": "id", "partitionKey": false, "primaryKey": true, "type": "Int64" }, { "autoId": false, "description": "", "id": 101, "name": "vector", "params": [ { "key": "dim", "value": "5" } ], "partitionKey": false, "primaryKey": false, "type": "FloatVector" } ], "indexes": [ { "fieldName": "vector", "indexName": "vector", "metricType": "COSINE" } ], "load": "LoadStateLoaded", "partitionsNum": 1, "properties": [], "shardsNum": 1 }}