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

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

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

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

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

📘ノート
  • Serving クラスターを使用している場合は、クラスターエンドポイントを使用します。
    • 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}}
リクエスト・ボディ
dbNamestring必要

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

propertiesobject

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

database.replica.numberinteger

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

database.resource_groupsstring

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

database.diskQuota.mbinteger

新しいデータベースのディスク容量の最大サイズ(MB単位)です。

database.max.collectionsinteger

新しいデータベースで許可されるコレクションの最大数です。

database.force.deny.writingboolean

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

database.force.deny.readingboolean

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

database.force.deny.ddlboolean

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

database.force.deny.collectionDDLboolean

新しいデータベースにコレクションDDL操作の拒否を強制するかどうか。

database.force.deny.partitionDDLboolean

新しいデータベースにパーティションDDL操作の拒否を強制するかどうか。

database.force.deny.indexboolean

新しいデータベースにインデックスDDL操作の拒否を強制するかどうか。

database.force.deny.flushboolean

新しいデータベースにフラッシュDDL操作の拒否を強制するかどうか。

database.force.deny.compactionboolean

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

timezonestring

新しいデータベースのIANAタイムゾーン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
}
}'
レスポンス

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

codeinteger

レスポンスコードです。

dataobject

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

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

codeinteger

レスポンスコードです。

messagestring

エラーメッセージです。

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