Describe Database

This operation describes the specified database.

POST

/v2/vectordb/databases/describe

Cluster Endpoint

The base URL for this API is in the following format:

https://${CLUSTER_ENDPOINT}

📘Notes

• You need to fill in ${CLUSTER_ENDPOINT} with that of your Zilliz Cloud cluster.
• To get the endpoint, refer to On Zilliz Cloud Console or use the Describe Cluster V2 API to extract the values from the responses.

export CLUSTER_ENDPOINT=""

Parameters

Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges or a pair of colon-joined username and password, like username:password.

Example Value: Bearer {{TOKEN}}

Request Bodyapplication/json

dbNamestringrequired

The name of the target 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"
}'

Responses200 - application/json

SUCCESS

codeinteger

Response code.

dataobject

The properties of the specified database in key-value pairs.

database.replica.numberinteger

The number of replicas for the specified database.

database.resource_groupsstring

The names of the resource groups associated with the specified database in a common-separated list.

database.diskQuota.mbinteger

The maximum size of the disk space for the specified database, in megabytes (MB).

database.max.collectionsinteger

The maximum number of collections allowed in the specified database.

database.force.deny.writingboolean

Whether to force the specified database to deny writing operations.

database.force.deny.readingboolean

Whether to force the specified database to deny reading operations.

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

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