查看 Collection 详情
Describes the details of a collection.
该 API 的 Base URL 格式如下:
https://${CLUSTER_ENDPOINT}
- 你需要填入您的 Zilliz Cloud 集群的
${CLUSTER_ENDPOINT}
。 - 您可以参考 On Zilliz Cloud 控制台或使用 查看集群详情 V2 来获取集群的 Endpoint.
export CLUSTER_ENDPOINT=""
认证令牌,应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码,如 username:password
。
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"
}'
响应码。
响应负载,包含了指定 Collection 的详细信息。
已分配给 Collection 的别名列表。
Collection 的别名。
当前 Collection 的主键是否自动增长。
创建当前 Collection 时分配的 ID。
当前 Collection 的名称。
当前 Collection 的一致性级别。
当前 Collection 的描述。
是否已启用保留的动态字段,用于以键值对的形式存放 Schema 中未定义的字段。
当前 Collection 的字段列表。
A field object.
当前字段是否自动增长。
当前字段的描述。
当前字段的 ID。
当前字段的名称。
其它字段参数。
A field parameter in a key-value pair
字段参数名称。
字段参数取值。
当前字段是否为 Partition Key。
当前字段是否为主键。
当前字段值的数据类型。
索引列表。
A index object
当前索引对应的字段名称。
当前索引的名称。
当前索引使用的相似性度量方式。
当前 Collection 的载入状态。
当前 Collection 的 Partition 数量。
当前 Collection 的额外属性。
A collection property object in a key-value pair.
属性名称。
属性取值。
Returns an 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": []
}
}