查看 Collection 详情 (V2)

Describes the details of a collection.

POST/v2/vectordb/collections/describe

连接端点

集群端点项目端点（按需）

该 API 的 Base URL 格式如下：

https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

📘说明

• 如果您使用的是服务集群，请使用集群端点。

  • Free 与 Serverless 版

    https://{cluster-id}.serverless.{region}.vectordb.zillizcloud.com

  • Dedicated 版

    https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

• 你需要填入您的 Zilliz Cloud 集群的 ${CLUSTER_ENDPOINT}。
• 您可以使用 查看集群详情 V2 来获取集群的 Endpoint.

export CLUSTER_ENDPOINT="https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530"

参数

Authorizationstringheaderrequired

认证令牌，应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 username:password。如果您使用的是项目端点，则仅具备足够权限的有效 API 密钥适用。

示例值：Bearer {{TOKEN}}

请求体application/json

dbNamestring

Database 名称。设置为不存在的 Database 会导致错误。如果未指定，则使用默认 Database。

collectionNamestring必填项

Collection 名称。设置为不存在的 Collection 会导致错误。

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/describe" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "test_collection"
}'

响应200 - application/json

SUCCESS

codeinteger

响应码。

示例值：0

dataobject

响应负载，包含了指定 Collection 的详细信息。

aliasesarray

已分配给 Collection 的别名列表。

[]aliasesstring

Collection 的别名。

autoIDboolean

当前 Collection 的主键是否自动增长。

collectionIDinteger<int64>

创建当前 Collection 时分配的 ID。

collectionNamestring

当前 Collection 的名称。

consistencyLevelstring

当前 Collection 的一致性级别。

枚举值：

StrongBoundedEventual

descriptionstring

当前 Collection 的描述。

enableDynamicFieldboolean

是否已启用保留的动态字段，用于以键值对的形式存放 Schema 中未定义的字段。

externalSourcestring

如果当前 Collection 是外部 Collection，则返回 JSON 编码的外部数据源配置。Zilliz Cloud Volume 中的对象 URL 适用。

externalSpecstring

如果当前 Collection 是外部 Collection，则返回 JSON 编码的外部规范。该字段的内容可能因连接器类型和源数据格式而异，可能包括但不限于文件格式、字段映射等。

fieldsarray

当前 Collection 的字段列表。

[]fieldsobject

一个字段对象。

namestring

当前字段的名称。

primaryKeyboolean

指示当前字段是否为主键。

partitionKeyboolean

指示当前字段是否为 Partition Key。

autoIdboolean

指示当前字段是否为自动生成的 ID。

descriptionstring

当前字段的描述。

nullableboolean

指示当前字段是否允许空值。

defaultValuestring

当前字段的默认值。当前值仅在字段有默认值时可用。

isFunctionOutputboolean

指示当前字段是否为函数的派生字段。当前值仅在字段是从函数派生时可用。

typestring

当前字段的数据类型。

idstring

当前字段的唯一标识符。

paramsobject

当前字段的参数。当前值仅在字段有参数时可用。

elementTypestring

当前字段中元素的数据类型。当前值仅在字段为 Array 时可用。

functionsarray

当前 Collection 的函数列表。

[]functionsobject

一个 Function 对象。

namestring

当前 Function 的名称。

descriptionstring

当前 Function 的描述。

typestring

当前 Function 的类型。

idstring

当前 Function 的 ID。

inputFieldNamesarray

当前 Function 的输入字段名称。

[]inputFieldNamesstring

输入字段的名称。

outputFieldNamesarray

当前 Function 的输出字段名称。

[]outputFieldNamesstring

输出字段的名称。

paramsobject

当前 Function 的参数。

indexesarray

索引列表。

[]indexesobject

一个索引对象。

indexNamestring

当前索引的名称。

fieldNamestring

与当前索引关联的字段名称。

metricTypestring

当前索引的度量类型。

loadstring

当前 Collection 的载入状态。

partitionsNuminteger

当前 Collection 的 Partition 数量。

propertiesarray

当前 Collection 的额外属性。

[]propertiesobject

以键值对形式呈现的 Collection 属性。

keystring

属性名称。

valuestring

属性取值。

FAILURE

返回错误消息。

codeinteger

响应码。

messagestring

错误描述。

MANAGED COLLECTION

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

EXTERNAL COLLECTION

{
    "code": 0,
    "data": {
        "aliases": [],
        "autoId": false,
        "collectionID": 448707763883002000,
        "collectionName": "test_collection",
        "consistencyLevel": "Bounded",
        "description": "",
        "enableDynamicField": true,
        "externalSource": "volume://volume-vdc/demo_lance/",
        "externalSpec": "{\"format\":\"lance-table\"}",
        "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": []
    }
}