跳到主要内容

重命名 Collection

This operation renames an existing collection.

POST
/v2/vectordb/collections/rename
集群 Endpoint

该 API 的 Base URL 格式如下：

https://${CLUSTER_ENDPOINT}

📘说明
  • 你需要填入您的 Zilliz Cloud 集群的 ${CLUSTER_ENDPOINT}。
  • 您可以使用 查看集群详情 V2 来获取集群的 Endpoint.
export CLUSTER_ENDPOINT=""
参数
Authorizationstringheaderrequired

认证令牌。

示例值：Bearer {{TOKEN}}
请求体application/json
collectionNamestring必填项

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

dbNamestring

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

newDbNamestring

操作完成后 Collection 所属的数据库名称。默认为 default。若指定的值不是 Collection 原先所属的数据库，则该操作将移动 Collection 到指定的数据库。设置为不存在的数据库将导致错误。

newCollectionNamestring必填项

操作完成后 Collection 的名称。设置为 Collection 的原有名称将导致错误。

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

成功响应。

codeinteger

响应码。

示例值：0
dataobject

响应载荷。为空对象。

返回错误消息。

codeinteger

响应码。

messagestring

错误描述。

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