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

データベースを作成 (V2)

この操作は、指定されたクラスターに新しいデータベースを作成します。

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

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 key、または username:password のようにコロンで連結した username と password の組み合わせを指定する必要があります。project endpoint を使用している場合は、十分な権限を持つ有効な API key のみ使用できます。

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

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

propertiesobject

新しいデータベースのプロパティ。キーと値のペアで指定します。

database.replica.numberinteger

新しいデータベースのレプリカ数。

database.resource_groupsstring

新しいデータベースに関連付けられる resource group の名前。カンマ区切りのリストで指定します。

database.diskQuota.mbinteger

新しいデータベースのディスク領域の最大サイズ。単位はメガバイト (MB) です。

database.max.collectionsinteger

新しいデータベースで許可される collection の最大数。

database.force.deny.writingboolean

新しいデータベースで書き込み操作を強制的に拒否するかどうか。

database.force.deny.readingboolean

新しいデータベースで読み取り操作を強制的に拒否するかどうか。

database.force.deny.ddlboolean

新しいデータベースですべての DDL 操作を強制的に拒否するかどうか。

database.force.deny.collectionDDLboolean

新しいデータベースで collection の DDL 操作を強制的に拒否するかどうか。

database.force.deny.partitionDDLboolean

新しいデータベースで partition の DDL 操作を強制的に拒否するかどうか。

database.force.deny.indexboolean

新しいデータベースで index の DDL 操作を強制的に拒否するかどうか。

database.force.deny.flushboolean

新しいデータベースで flush の DDL 操作を強制的に拒否するかどうか。

database.force.deny.compactionboolean

新しいデータベースで compaction の DDL 操作を強制的に拒否するかどうか。

timezonestring

新しいデータベースの IANA Time Zone ID。

cipher.enabledstring

新しいデータベースで CMEK 暗号化を有効にするかどうか。"true" または "false" に設定します。

cipher.keystring

新しいデータベースの CMEK 暗号化ルートキー。

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

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

空のオブジェクトを返します。

codeinteger

レスポンスコード。

dataobject

空のオブジェクトであるレスポンスペイロード。

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": {}
}
Ctrl I