メインコンテンツまでスキップ

データベースの説明 (V2)

この操作は、指定されたデータベースについて説明します。

POST/v2/vectordb/databases/describe
接続エンドポイント

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

📘ノート
  • サービングクラスターを使用している場合は、クラスターエンドポイントを使用してください。

    • Free & Serverless

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

    • Dedicated

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

  • ${CLUSTER_ENDPOINT} を、あなたのZilliz Cloudクラスターのエンドポイントに置き換える必要があります。
  • エンドポイントを取得するには、Describe Cluster V2 APIを使用してレスポンスから値を抽出してください。
shell
export CLUSTER_ENDPOINT="https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530"
パラメータ
Authorizationstringheader必要

認証トークンは、適切な権限を持つAPIキー、またはコロンで連結されたユーザー名とパスワードのペア（例：username:password）である必要があります。プロジェクトエンドポイントを使用する場合、十分な権限を持つ有効なAPIキーのみが適用されます。

値の例： Bearer {{TOKEN}}
リクエスト・ボディapplication/json
dbNamestring必要

作成する新しいデータベースの名前。

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/databases/describe" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "my_database"
}'
レスポンス200 OK - application/json

指定されたデータベースのプロパティを返します。

codeinteger

レスポンスコード。

dataobject

指定されたデータベースの詳細。

dbNamestring

データベースの名前。

dbIDinteger

データベースのID。

propertiesarray

指定されたデータベースのプロパティ（キーと値のペア）。

[]propertiesobject

データベースのプロパティを表すキーと値のペア。

keystring

プロパティ名。

valuestring

The property value.

エラーメッセージを返します。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

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