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

データベースのプロパティを変更 (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 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

指定されたデータベースで許可されるコレクションの最大数。

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/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