向量数据库VikingDB
控制面接口统一通过 TOP 开放网关调用,用于库管理、用户管理等运维操作。
Region 名称 | 域名 |
|---|---|
cn-beijing |
|
调用控制面接口前,需获取火山引擎访问密钥(AccessKey),包括:
请妥善保管您的 AK/SK,避免泄露。
参数 | 类型 | 是否必填 | 位置 | 描述 |
|---|---|---|---|---|
Action | String | 是 | query | 要执行的操作,例如 |
Version | String | 是 | query | API 的版本,固定取值: |
请求示例:
POST /?Action=<接口名>&Version=2025-06-09 HTTP/1.1 Host: vikingdb.cn-beijing.volcengineapi.com Content-Type: application/json Authorization: <火山引擎 AK/SK 签名> { /* 请求参数 JSON */ }
{ "ResponseMetadata": { "RequestId": "<请求 ID>", "Action": "<Action 名>", "Version": "2025-06-09", "Service": "vikingdb", "Region": "<区域>" }, "Result": { /* 各接口业务响应体 */ } }
{ "ResponseMetadata": { "RequestId": "...", "Action": "...", "Version": "...", "Service": "...", "Region": "...", "Error": { "Code": "<错误码>", "Message": "<错误信息,含 Request ID>" } }, "Result": null }
HTTP 状态 |
| 含义 / 触发场景 |
|---|---|---|
400 |
| 参数缺失、格式错误、校验不通过 |
400 |
| 必填参数缺失 |
401 |
| API Key / 签名缺失或无效 |
403 |
| 身份校验失败 |
403 |
| 无权限执行该操作 |
403 |
| 账号未开启 AgentPlan 抵扣 |
404 |
| 指定库 / 资源不存在 |
429 |
| 超出配额 / 限流 |
500 |
| 服务内部错误 |
接口名称 | 说明 |
|---|---|
| 库用户列表 |
| 获取库 API Key |
| 注册库用户(企业版支持) |
| 删除库用户(企业版支持) |