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

インデックスのプロパティを変更する（V2）

この操作は、インデックスのプロパティを変更します。

POST/v2/vectordb/indexes/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必要

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

indexNamestring必要

対象インデックスの名前です。

propertiesobject必要

設定する新しいインデックスパラメーターです。

mmap.enabledboolean

現在のインデックスに対してメモリマッピングを有効にするかどうかです。

indexoffsetcache.enabledboolean

インデックスオフセットをメモリにキャッシュするかどうかです。

warmupboolean

インデックスをウォームアップするかどうかです。

  • sync: セグメントがロード済みと見なされる前にウォームアップします。
  • async: ロード後にバックグラウンドでウォームアップします。
  • disable: 事前にウォームアップせず、オンデマンドでロードします。
bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

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

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

codeinteger

レスポンスコードです。

dataobject

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

codeinteger

レスポンスコードです。

messagestring

エラーメッセージです。

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