文档中心

向量数据库VikingDB

请输入

用户管理（Users）

list_users-库用户列表

概述

ListOpenVikingUser 接口用于查询指定库下的用户列表，返回脱敏的 API Key（统一返回掩码）。

前置条件

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

请求接口

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

请求参数

字段	类型	必填	说明
`ResourceID`	string	✅	库 ID
`UserID`	string	否	按用户过滤
`Role`	string	否	按角色过滤
`Page`	int	否	页码
`Limit`	int	否	每页数量

响应消息

字段	类型	说明
`UserList`	array	用户列表，`ApiKey` 固定脱敏（统一返回掩码）
`Total`	int	总数

UserList 元素结构：

字段	类型	说明
`UserID`	string	用户 ID
`Role`	string	用户角色
`ApiKey`	string	API Key（脱敏）

常见错误码

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

完整示例

请求示例

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

{
    "ResourceID": "ov-xxx",
    "Page": 1,
    "Limit": 10
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20250609xxxxxxxxxxxxxxxx",
        "Action": "ListOpenVikingUser",
        "Version": "2025-06-09",
        "Service": "vikingdb",
        "Region": "cn-beijing"
    },
    "Result": {
        "UserList": [
            {
                "UserID": "default",
                "Role": "admin",
                "ApiKey": "sk-********************"
            },
            {
                "UserID": "user1",
                "Role": "user",
                "ApiKey": "sk-********************"
            }
        ],
        "Total": 2
    }
}

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

这个页面对您有帮助吗？

有用

无用

向量数据库VikingDB

请求示例 #

响应示例 #

请求示例

响应示例