You need to enable JavaScript to run this app.
导航

drop

最近更新时间2023.11.09 18:59:53

首次发布时间2023.11.03 15:00:09

概述

/collection/drop 接口用于删除已创建的数据集 Collection。

注意

  • 执行 Collection 删除将会永久删除指定 Collection 下的所有数据,请谨慎操作。
  • 在删除 Collection 之前,必须先删除 Collection 关联的所有 Index,才能成功删除 Collection。

请求接口

说明

请求向量数据库 VikingDB 的 OpenAPI 接口时,需要构造签名进行鉴权,详细的 OpenAPI 签名调用方法请参见 API签名调用指南

URI

/api/collection/drop

统一资源标识符

请求方法

POST

客户端对向量数据库服务器请求的操作类型

请求头

Content-Type: application/json

请求消息类型

Authorization: HMAC-SHA256 ***

鉴权

请求参数

参数

类型

是否必选

参数说明

collection_name

string

指定要删除的 Collection 名称。

  • 只能使用英文字母、数字、下划线_,并以英文字母开头,不能为空。
  • 长度要求:[1, 128]。
  • Collection 名称不能重复。

响应消息

参数

参数说明

code

状态码

message

返回信息

request_id

标识每个请求的唯一标识符

状态码说明

状态码

http状态码

返回信息

状态码说明

0

200

success

删除 Collection 执行成功。

1000006

400

operation not allowed: associated indexes exist

Collection 仍存在相关联的 Indexes,不允许删除。

1000003

400

invalid request:%s

非法参数:

  • Collection 未指定。

1000001

401

unauthorized

请求头中缺乏鉴权信息。

1000002

403

no permission

权限不足。

完整示例

请求消息

curl -i -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: HMAC-SHA256 ***' \
  http://***/api/collection/drop \
  -d '{
    "collection_name": "test_name"
}'

响应消息

执行成功返回:

HTTP/1.1 200 OK
Content-Length: 43
Content-Type: application/json
 
{"code":0,"msg":"success","request_id":"021695029537650fd001de666660000000000000000000230da93"}

执行失败返回:

HTTP/1.1 400 OK
Content-Length: 43
Content-Type: application/json
 
{"code":1000006,"msg":"associated indexes exist","request_id":"021695029537650fd001de666660000000000000000000230da93"}