跳到主要内容

修改 Collection 属性

This operation alters the properties of a collection.

POST
/v2/vectordb/collections/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

Database 名称。

collectionNamestring必填项

Collection 名称。

propertiesobjectrequired

待修改 Collection 属性。

mmmap.enabledboolean

是否启用内存映射特性。将该属性设置为 true 允许直接从磁盘访问 Collection，而无需将其加载到内存，从而扩大 Collection 容量。

collection.ttl.secondsinteger

Collection 的 TTL（秒）。将该属性设置为非零值将在指定秒数后自动删除过期文档。

partitionkey.isolationboolean

是否启用分区键隔离特性。将该属性设置为 true 确保具有相同分区键的文档始终存储在相同的分区中，从而提高查询性能。

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/alter_properties" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "test_collection",
    "properties": {
        "mmmap.enabled": true
    }
}'
响应200 - application/json
codeinteger

响应码。

dataobject

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

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