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

コレクションプロパティの変更 (V2)

この操作は、コレクションのプロパティを変更します。

POST/v2/vectordb/collections/alter_properties
接続エンドポイント

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

コレクションが属するデータベースの名前。存在しないデータベースを指定するとエラーになります。未指定の場合は、デフォルトのデータベースが使用されます。

collectionNamestring必要

対象コレクションの名前。 存在しないコレクションを指定するとエラーになります。

propertiesobject必要

変更するコレクションのプロパティ。

collection.ttl.secondsinteger

コレクションの有効期間（TTL）を秒単位で指定します。

collection.autocompaction.enabledboolean

コレクションの自動 Compaction を有効にするかどうか。

collection.descriptionstring

コレクションの説明。

collection.on.truncatingboolean

コレクションが現在 truncate 処理中かどうか。true の場合、Compaction は禁止されます。

collection.function.allowInsertNonBM25FunctionOutputsboolean

BM25 以外の関数出力の挿入を許可するかどうか。

collection.insertRate.max.mbnumber

挿入レート制限の最大値（MB/s.）。

collection.insertRate.min.mbnumber

挿入レート制限の最小値（MB/s.）。

collection.deleteRate.max.mbnumber

削除レート制限の最大値（MB/s.）。

collection.deleteRate.min.mbnumber

削除レート制限の最小値（MB/s.）。

collection.bulkLoadRate.max.mbnumber

バルクロードレート制限の最大値（MB/s.）。

collection.bulkLoadRate.min.mbnumber

バルクロードレート制限の最小値（MB/s.）。

collection.queryRate.max.qpsnumber

クエリレート制限の最大値（QPS）。

collection.queryRate.min.qpsnumber

クエリレート制限の最小値（QPS）。

collection.searchRate.max.vpsnumber

検索レート制限の最大値（VPS）。

collection.searchRate.min.vpsnumber

検索レート制限の最小値（VPS）。

collection.diskProtection.diskQuota.mbnumber

コレクションのディスククォータの最大値（MB）。

collection.replica.numberinteger

コレクションのレプリカ数。

collection.resource_groupsstring

コレクションに関連付けられたリソースグループ名のカンマ区切りリスト。

mmap.enabledboolean

コレクションのメモリマッピングを有効にするかどうか。

partitionkey.isolationboolean

コレクションのパーティションキー分離を有効にするかどうか。

ttl_fieldstring

TTL ベースの有効期限に使用するフィールドの名前。

warmup.scalarFieldboolean

ロード時にスカラーフィールドのデータをメモリにプリロードするかどうか。

warmup.scalarIndexboolean

ロード時にスカラーインデックスのデータをメモリにプリロードするかどうか。

warmup.vectorFieldboolean

ロード時にベクトルフィールドのデータをメモリにプリロードするかどうか。

warmup.vectorIndexboolean

ロード時にベクトルインデックスのデータをメモリにプリロードするかどうか。

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/alter_properties" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "test_collection",
    "properties": {
        "mmap.enabled": true
    }
}'
レスポンス200 OK - application/json

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

codeinteger

レスポンスコード。

dataobject

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

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