查看 Database 详情

This operation describes the specified database.

POST

/v2/vectordb/databases/describe

集群 Endpoint

该 API 的 Base URL 格式如下：

https://${CLUSTER_ENDPOINT}

📘说明

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

export CLUSTER_ENDPOINT=""

参数

Authorizationstringheaderrequired

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

示例值：Bearer {{TOKEN}}

请求体application/json

dbNamestring必填项

目标 Database 名称。

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/databases/describe" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "my_database"
}'

响应200 - application/json

SUCCESS

codeinteger

响应码。

dataobject

以键值对的方式提供的指定 Database 的属性。

database.replica.numberinteger

指定 Database 的副本数量。

database.resource_groupsstring

与指定 Database 关联的资源组名称，以逗号分隔的列表形式提供。

database.diskQuota.mbinteger

指定 Database 的磁盘空间最大容量，以兆字节 (MB) 为单位。

database.max.collectionsinteger

指定 Database 中允许的最大 Collection 数量。

database.force.deny.writingboolean

是否强制指定 Database 拒绝写入操作。

database.force.deny.readingboolean

是否强制指定 Database 拒绝读取操作。

FAILURE

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "code": 0,
    "cost": 0,
    "data": {}
}