You need to enable JavaScript to run this app.
文档中心
文档控制台
注册
向量数据库VikingDB

向量数据库VikingDB

复制全文
下载 pdf
数据库管理
数据库管理使用说明
复制全文
下载 pdf
数据库管理使用说明

调用方式

控制面接口统一通过 TOP 开放网关调用,用于库管理、用户管理等运维操作。

支持的域名及 Region

Region 名称

域名

cn-beijing

vikingdb.cn-beijing.volcengineapi.com

鉴权

调用控制面接口前,需获取火山引擎访问密钥(AccessKey),包括:

  • AK(AccessKeyID):用于标识用户
  • SK(AccessKeySecret):用于验证用户的密钥

请妥善保管您的 AK/SK,避免泄露。

请求公共参数

参数

类型

是否必填

位置

描述

Action

String

query

要执行的操作,例如 ListOpenVikingCollectionUser

Version

String

query

API 的版本,固定取值:2025-06-09

请求示例:

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 状态

Error.Code

含义 / 触发场景

400

InvalidParameter

参数缺失、格式错误、校验不通过

400

MissingParameter

必填参数缺失

401

AuthenticationError

API Key / 签名缺失或无效

403

AuthenticationError

身份校验失败

403

AccessDenied

无权限执行该操作

403

AgentPlanDeductNotEnabled

账号未开启 AgentPlan 抵扣

404

ResourceNotExist

指定库 / 资源不存在

429

QuotaExceeded

超出配额 / 限流

500

InternalError

服务内部错误

接口列表

接口名称

说明

ListOpenVikingUser

库用户列表

AccessOpenVikingApiKey

获取库 API Key

RegisterOpenVikingUser

注册库用户(企业版支持)

DeleteOpenVikingUser

删除库用户(企业版支持)

最近更新时间:2026.07.15 21:09:30
这个页面对您有帮助吗?
有用
有用
无用
无用