[説明] このページは機械翻訳された日本語版です。内容に誤りがございましたら、報告していただけると助かります。

Describe Database (V2)

This operation describes the specified database.

POST/v2/vectordb/databases/describe

Connection Endpoint

Cluster EndpointProject Endpoint (On-Demand)

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

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

📘Notes

Use the cluster endpoint if you are using serving clusters.
- Free & Serverless
  https://{cluster-id}.serverless.{region}.vectordb.zillizcloud.com
- Dedicated
  https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530

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

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

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. If you are using a project endpoint, only a valid API key with sufficient permissions applies.

Example Value: Bearer {{TOKEN}}

Request Bodyapplication/json

dbNamestringrequired

The name of the new database to be created.

export TOKEN="db_admin:xxxxxxxxxxxxx"

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

Responses200 - application/json

SUCCESS

codeinteger

Response code.

dataobject

The details of the specified database.

dbNamestring

The name of the database.

dbIDinteger

The ID of the database.

propertiesarray

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

[]propertiesobject

A key-value pair representing a database property.

keystring

The property name.

Possible Values:

valuestring

The property value.

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 0,
    "cost": 0,
    "data": {
        "dbName": "my_database",
        "dbID": 123,
        "properties": [
            {
                "key": "database.replica.number",
                "value": "1"
            }
        ]
    }
}