跳到主要内容

修改字段属性

This operation alters the properties of a field in a collection.

POST
/v2/vectordb/collections/fields/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 名称。

fieldNamestring必填项

待修改属性的字段名称。

fieldParamsobjectrequired

The properties of the field to alter.

max_lengthinteger

字段的最大长度。将该属性设置为非零值将限制字段的最大长度为指定值。
该参数仅适用于 VarChar 类型的字段。

max_capacityinteger

字段的最大容量。将该属性设置为非零值将限制字段的最大容量为指定值。
该参数仅适用于 Array 类型的字段。

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/fields/alter_properties" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "test_collection",
    "fieldName": "my_varchar",
    "fieldParams": {
        "max_length": 100
    }
}'
响应200 - application/json
codeinteger

响应码。

dataobject

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

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