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

データベースプロパティの変更 (V2)

この操作は、指定されたデータベースのプロパティを変更します。

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

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必要

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

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

指定されたデータベースにflush 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/alter" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "my_database",
    "properties": {
        "database.replica.number": 2
    }
}'
レスポンス200 OK - application/json

空のレスポンスを返します。

codeinteger

レスポンスコード。

dataobject

空のレスポンス。

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

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