list

最近更新时间:2024-05-28 21:48:11

我的收藏

功能介绍

/alias/list 接口用于查询指定数据库下所有集合的别名。

请求示例

说明:
腾讯云向量数据库(Tencent Cloud VectorDB)通过 HTTP 协议进行数据写入和查询等操作,使用 /alias/set 接口之前,您需要做相关准备事项,并了解 /alias/set 接口的请求方式与 URL 拼接地址。具体信息,请参见使用前阅读
注意:
如下示例可直接复制,在 CVM 运行之前,您需在文本编辑器将 api_key=A5VOgsMpGWJhUI0WmUbY******************** 与 10.0.X.X 依据实际情况进行替换。
curl -i -X POST \\
-H 'Content-Type: application/json' \\
-H 'Authorization: Bearer account=root&api_key=A5VOgsMpGWJhUI0WmUbY********************' \\
http://10.0.X.X:80/alias/list \\
-d '{
  "database": "db-test"
}'

请求参数

参数
是否必选
参数含义
配置方法及要求
database
设置 Database 名称。
Database 命名要求如下:
只能使用英文字母,数字,下划线_、中划线-,并以英文字母开头。
长度要求:[1,128]。

响应消息

HTTP 响应消息体是服务器返回给客户端的数据,通常包含了请求的结果或者所请求的资源。/alias/list 接口返回的状态码以及相关信息,如下表所示。
状态码
含义
响应信息
200
创建成功
HTTP/1.1 200 OK
Content-Length: 60
Content-Type: application/json
{
"code": 0,
"msg": "operation success",
"collection": {
"database": "db-test",
"collection": "coll-test",
"alias": [
"alias-test",
"alias-other"
]
}
}
400
创建失败
HTTP/1.1 400 Bad Request
Content-Length: 45
Content-Type: application/json

{"code":1,"msg":"operation failed, reason ......"}