📘 このページは機械翻訳された日本語版です。内容に誤りがございましたら、報告していただけると助かります。

Alter Index Properties

This operation alters the properties of an index.

POST

/v2/vectordb/indexes/alter_properties

Cluster Endpoint

The base URL for this API is in the following format:

https://${CLUSTER_ENDPOINT}

📘Notes

• You need to fill in ${CLUSTER_ENDPOINT} with that of your Zilliz Cloud cluster.
• To get the endpoint, use the Describe Cluster V2 API to extract the values from the responses.

export CLUSTER_ENDPOINT=""

Parameters

Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges or a pair of colon-joined username and password, like username:password.

Example Value: Bearer {{TOKEN}}

Request Bodyapplication/json

dbNamestring

The name of the database that to which the collection belongs . Setting this to a non-existing database results in an error.

collectionNamestringrequired

The name of the target collection. Setting this to a non-existing collection results in an error.

indexNamestringrequired

The name of the target index.

propertiesobjectrequired

The new index parameters to be set.

mmap.enabledboolean

Whether to enable memory mapping for the current index.

export TOKEN="db_admin:xxxxxxxxxxxxx"

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

Responses200 - application/json

SUCCESS

codeinteger

Response code.

dataobject

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 0,
    "cost": 0,
    "data": {}
}