Describe Collection (V2)
Describes the details of a collection.
The base URL for this API is in the following format:
https://${CLUSTER_ENDPOINT}
- You need to fill in
${CLUSTER_ENDPOINT}with that of your Zilliz Cloud cluster. - To get the endpoint, use the Describe Cluster V2 API to extract the values from the responses.
export CLUSTER_ENDPOINT=""
The authentication token should be an API key with appropriate privileges or a pair of colon-joined username and password, like username:password.
The name of the database which the collection belongs to. Setting this to a non-existing database results in an error.
The name of the target collection. Setting this to a non-existing collection results in an error.
export TOKEN="db_admin:xxxxxxxxxxxxx"
curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/describe" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
"collectionName": "test_collection"
}'
Response code.
Response payload, which carries detailed information about the specified collection.
A list aliases assigned to the collection.
An alias of the collection.
Whether the primary key of this collection automatically increments.
The ID assigned to the collection upon creation.
The name of the current collection.
The consistency level of the current collection.
The description of the collection.
Whether the reserved dynamic field named $meta is enabled to save non-schema-defined fields and their values in key-value pairs.
The collection fields in an array
A field object.
The name of the current field.
Indicates whether the current field is a primary key.
Indicates whether the current field is a partition key.
Indicates whether the current field is an auto-generated ID.
The description of the current field.
Indicates whether the current field allows null values.
The default value of the current field. This value is only available for fields that have a default value.
Indicates whether the current field is an derived field of a function. This value is only available for fields that are derived from a function.
The data type of the current field.
The unique identifier of the current field.
The parameters of the current field. This value is only available for fields that have parameters.
The data type of the elements in the current field. This value is only available for fields that are arrays.
The collection functions in an array
A function object.
The name of the current function.
The description of the current function.
The type of the current function.
The ID of the current function.
The input field names of the current function.
The name of an input field.
The output field names of the current function.
The name of an output field.
The parameters of the current function.
The created indexes in an array
An index object.
The name of the current index.
The name of the field associated with the current index.
The metric type of the current index.
The load status of the current collection.
The number of partitions in the collection.
Extra collection properties in an array.
A collection property object in a key-value pair.
The property name
The property value.
Returns an error message.
Response code.
Error message.
{
"code": 0,
"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": []
}
}