跳到主要内容

查看 Collection 详情

Describes the details of a collection.

POST
/v2/vectordb/collections/describe
集群 Endpoint

该 API 的 Base URL 格式如下:

https://${CLUSTER_ENDPOINT}

📘说明
export CLUSTER_ENDPOINT=""
参数
Authorizationstringheaderrequired

认证令牌,应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码,如 username:password

示例值:Bearer {{TOKEN}}
请求体application/json
collectionNamestring必填项

Collection 名称。

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"
}'
响应200 - application/json
codeinteger

响应码。

示例值:0
dataobject

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

aliasesarray

已分配给 Collection 的别名列表。

[]aliasesstring

Collection 的别名。

autoIDboolean

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

collectionIDinteger<int64>

创建当前 Collection 时分配的 ID。

collectionNamestring

当前 Collection 的名称。

consistencyLevelstring

当前 Collection 的一致性级别。

descriptionstring

当前 Collection 的描述。

enableDynamicFieldboolean

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

fieldsarray

当前 Collection 的字段列表。

[]fieldsobject

A field object.

autoIdboolean

当前字段是否自动增长。

descriptionstring

当前字段的描述。

idinteger

当前字段的 ID。

namestring

当前字段的名称。

paramsarray

其它字段参数。

[]paramsobject

A field parameter in a key-value pair

keystring

字段参数名称。

valuestring

字段参数取值。

partitionKeyboolean

当前字段是否为 Partition Key。

primaryKeyboolean

当前字段是否为主键。

typestring

当前字段值的数据类型。

indexesarray

索引列表。

[]indexesobject

A index object

fieldNamestring

当前索引对应的字段名称。

indexNamestring

当前索引的名称。

metricTypestring

当前索引使用的相似性度量方式。

loadstring

当前 Collection 的载入状态。

partitionNuminteger

当前 Collection 的 Partition 数量。

propertiesarray

当前 Collection 的额外属性。

[]propertiesobject

A collection property object in a key-value pair.

keystring

属性名称。

valuestring

属性取值。

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

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