Alter Field Properties

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

POST

/v2/vectordb/collections/fields/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, refer to On Zilliz Cloud Console or 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 which the collection belongs to. 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.

fieldNamestringrequired

The name of the field whose properties are to be altered.

fieldParamsobjectrequired

The properties of the field to alter.

max_lengthinteger

The maximum length of the field. Setting this to a non-zero value restricts the maximum length of the field to the specified value.
This parameter applies only when the field is of type VarChar.

max_capacityinteger

The maximum capacity of the field. Setting this to a non-zero value restricts the maximum capacity of the field to the specified value.
This parameter applies only when the field is of type 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
    }
}'

Responses200 - application/json

SUCCESS

codeinteger

Response code.

dataobject

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

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