重命名 Collection
This operation renames an existing collection.
POST
/v2/vectordb/collections/rename该 API 的 Base URL 格式如下:
https://${CLUSTER_ENDPOINT}
📘说明
- 你需要填入您的 Zilliz Cloud 集群的
${CLUSTER_ENDPOINT}
。 - 您可以参考 On Zilliz Cloud 控制台或使用 查看集群详情 V2 来获取集群的 Endpoint.
export CLUSTER_ENDPOINT=""
参数
Authorizationstringheaderrequired
The authentication token
示例值:Bearer {{TOKEN}}
请求体application/json
collectionNamestring必填项
目标 Collection 的名称。设置为不存在的 Collection 将导致错误。
newCollectionNamestring必填项
The name of the target collection after this operation. Setting this to the value of oldcollectionname results in an error.
export TOKEN="db_admin:xxxxxxxxxxxxx"
curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/rename" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
"collectionName": "test_collection",
"newCollectionName": "quick_setup"
}'
响应200 - application/json
A success response
codeinteger
响应码。
示例值:0
dataobject
响应载荷。为空对象。
Returns an error message.
codeinteger
响应码。
messagestring
错误描述。
{
"code": 0,
"data": {}
}