Describe Collection

Describes the details of a collection.

GET

/v1/vector/collections/describe

Cluster Endpoint

The base URL for this API is in the following format:

https://${CLUSTER_ENDPOINT}

📘Notes

• You need to fill in ${CLUSTER_ENDPOINT} with that of your Zilliz Cloud cluster.
• To get the endpoint, refer to On Zilliz Cloud Console or use the Describe Cluster API to extract the values from the responses.

export CLUSTER_ENDPOINT=""

Parameters

Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges or a pair of colon-joined username and password, like username:password.

Example Value: Bearer {{TOKEN}}

collectionNamestringqueryrequired

The name of the collection to describe.

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request GET \
--url "${CLUSTER_ENDPOINT}/v1/vector/collections/describe?collectionName=undefined" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"

Responses200 - application/json

SUCCESS

codeinteger

response code.

dataobject

Response payload which carries the collection details.

collectionNamestring

The name of the collection.

descriptionstring

An optional description of the collection.

fieldsarray

An field array

[]fieldsobject

A field object

autoIdboolean

Whether the primary key automatically increments. This field applies only when the current field is the primary key.

descriptionstring

An optional description of the field.

namestring

The name of the field.

primaryKeyboolean

Whether the field is a primary field.

typestring

The data type of the values in this field.

indexesarray

An index array

[]indexesobject

An index object

fieldNamestring

The name of the indexed field.

indexNamestring

The name of the generated index files.

metricTypestring

The metric type used to measure similarity between vectors

loadstring

The load status of the collection.

Possible Values:

unloadloadingloaded

enableDynamicFieldboolean

Whether the dynamic field feature is enabled for this collection.

FAILURE

A failure response.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "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": []
    }
}