Describe Collection

Describes the details of a collection.

Example

Describe the details of a collection named medium_articles:

export MILVUS_URI="http://localhost:19530"


curl --request GET \
     --url "${MILVUS_URI}/v1/vector/collections/describe?collectionName=medium_articles" \
     --header "accept: application/json" \
     --header "content-type: application/json"

Success response:

{
    "code": 200,
    "data": {
        "collectionName": "string",
        "description": "string",
        "fields": [
            {
                "autoId": true,
                "description": "string",
                "name": "string",
                "primaryKey": true,
                "type": "string"
            }
        ],
        "indexes": [
            {
                "fieldName": "string",
                "indexName": "string",
                "metricType": "string"
            }
        ],
        "load": "string",
        "shardsNum": 0,
        "enableDynamicField": true
    }
}

Request

Parameters

• Query parameters

  Parameter	Description
  collectionName	string(required) The name of the collection to describe.
  dbName	string The name of the database.

• No path parameters required

Request Body

No request body required

Response

Returns the specified collection in detail.

Response Bodies

• Response body if we process your request successfully

{
    "code": 200,
    "data": {
        "collectionName": "string",
        "description": "string",
        "enableDynamicField": "boolean",
        "fields": [
            {
                "autoId": "boolean",
                "description": "string",
                "name": "string",
                "primaryKey": "boolean",
                "type": "string"
            }
        ],
        "indexes": [
            {
                "fieldName": "string",
                "indexName": "string",
                "metricType": "string"
            }
        ],
        "load": "string",
        "shardsNum": "integer"
    }
}

• 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.

Property	Description
code	integer Indicates whether the request succeeds. 200: The request succeeds. Others: Some error occurs.
data	object A data object.
data.collectionName	string The name of the collection.
data.description	string An optional description of the collection.
data.fields	array An field array
data.fields[].autoId	boolean Whether the primary key automatically increments.
data.fields[].description	string An optional description of the field.
data.fields[].name	string The name of the field.
data.fields[].primaryKey	boolean Whether the field is a primary field.
data.fields[].type	string The data type of the values in this field.
data.indexes	array An index array
data.indexes[].fieldName	string The name of the indexed field.
data.indexes[].indexName	string The name of the generated index files.
data.indexes[].metricType	string The metric type used in the index process.
data.load	string The load status of the collection. Possible values are unload, loading, and loaded.
data.shardsNum	integer The number of shards in the collection.
data.enableDynamicField	boolean Whether the dynamic JSON feature is enabled for this collection.
message	string Indicates the possible reason for the reported error.

Possible Errors

Error Code	Description
800	database not found
1800	user hasn't authenticate
1802	missing required parameters