修改索引属性

This operation alters the properties of an index.

POST

/v2/vectordb/indexes/alter_properties

集群 Endpoint

该 API 的 Base URL 格式如下：

https://${CLUSTER_ENDPOINT}

📘说明

你需要填入您的 Zilliz Cloud 集群的 ${CLUSTER_ENDPOINT}。
您可以参考 Zilliz Cloud 控制台或使用查看集群详情 V2 来获取集群的 Endpoint.

export CLUSTER_ENDPOINT=""

参数

Authorizationstringheaderrequired

认证令牌，应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 username:password。

示例值：Bearer {{TOKEN}}

请求体application/json

dbNamestring

Collection 所属的数据库名称。设置为不存在的数据库将导致错误。

collectionNamestring必填项

目标 Collection 的名称。设置为不存在的 Collection 将导致错误。

indexNamestring必填项

目标索引的名称。

propertiesobjectrequired

要设置的新索引参数。

mmap.enabledboolean

是否为当前索引启用内存映射。

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": {
        "nlist": 1024
    }
}'

响应200 - application/json

SUCCESS

codeinteger

响应码。

dataobject

FAILURE

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

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