文档中心

向量数据库VikingDB

请输入

用户管理（Users）

get_user_access-获取库APIKey

概述

AccessOpenVikingApiKey 接口用于获取指定用户的真实 API Key（明文），可用于调用数据面接口。

前置条件

完成 "数据库管理使用说明" 页面的 AK/SK 获取后，可调用本接口。

请求接口

Action	AccessOpenVikingApiKey	接口标识
请求方法	POST	客户端请求类型

请求参数

字段	类型	必填	说明
`ResourceID`	string	✅	库 ID
`UserID`	string	否	企业版传入返回指定用户真实 API Key；个人版可不传，返回 `default` 用户

响应消息

字段	类型	说明
`UserID`	string	用户 ID
`Role`	string	用户角色
`ApiKey`	string	API Key（明文，可用于调用数据面接口）

注意：返回的 ApiKey 为明文，请妥善保管，避免泄露至公开环境。

常见错误码

HTTP 状态	`Error.Code`	含义 / 触发场景
404	`ResourceNotExist`	指定库或用户不存在

完整示例

请求示例

POST /?Action=AccessOpenVikingApiKey&Version=2025-06-09 HTTP/1.1
Host: vikingdb.cn-beijing.volcengineapi.com
Content-Type: application/json
Authorization: <火山引擎 AK/SK 签名>

{
    "ResourceID": "ov-xxx",
    "UserID": "user1"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20250609xxxxxxxxxxxxxxxx",
        "Action": "AccessOpenVikingApiKey",
        "Version": "2025-06-09",
        "Service": "vikingdb",
        "Region": "cn-beijing"
    },
    "Result": {
        "UserID": "user1",
        "Role": "user",
        "ApiKey": "sk-abc123def456ghi789jkl0"
    }
}

最近更新时间：2026.07.15 21:09:54

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

请求示例 #

响应示例 #

请求示例

响应示例