文档数据库 MongoDB 版
文档数据库 MongoDB 版
文档指南
请输入
- 文档首页
文档数据库 MongoDB 版API 参考账号管理DescribeDBAccounts
复制全文
下载 pdfDescribeDBAccounts
文档反馈
问问助手调用 DescribeDBAccounts 接口查询目标 MongoDB 实例下的账号列表。
请求类型
同步请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
InstanceId String 必选 示例值：mongo-replica-e405f8e2****
实例 ID。
说明
AccountName String 可选 示例值：apitest
数据库账号名称。支持模糊查询。
说明
若不设置该参数，表示不使用账号名称条件进行筛选。
AuthDB String 可选 示例值：admin
账号所属的数据库。支持模糊查询。
说明
若不设置该参数，表示不使用账号所属的数据库条件进行筛选。
PageSize Integer 可选 示例值：10
每页记录数，取值为 1~1000 间的整数，默认值为 10。
PageNumber Integer 可选 示例值：1
实例信息列表的页码，默认值为 1。取值为不超过 Integer 数据类型的最大值，起始值为 1。
返回参数
Total Integer 示例值：3
账号总数。
Accounts Object[] 示例值：
账号信息列表。
AccountName String 示例值：apitest
账号名称。
AccountType String 示例值：UserAdmin
账号类型。取值范围如下：
- Super：超级管理员账号，即 root 账号。
- UserAdmin：高权限账号，即对 admin 库有任意权限的账号。
- Normal：普通账号，即对 admin 库没有任何权限的账号。
说明
AccountPrivileges Object[]
当前账号所拥有的数据库权限列表。
DBName String 示例值：testdb
账号拥有权限的数据库。
RoleName String 示例值：readWrite
账号在当前数据库下拥有的权限。
AuthDB String 示例值：admin
账号所属的数据库。
CreateTime String 示例值：2024-08-09T09:24:56Z
账号的创建时间。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。
ModifyTime String 示例值：2024-08-09T09:24:56Z
账号最近一次的更新时间。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。
AccountDesc String 示例值：testdesc
账号的描述信息。
说明
仅当账号设置了描述信息时才会返回该参数。
示例
请求示例
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=DescribeDBAccounts&Version=2022-01-01 HTTP/1.1
Host: mongodb.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
"InstanceId":"mongo-replica-e405f8e2****"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20230604110420100232280022D31",
"Action": "DescribeDBAccounts",
"Version": "2022-01-01",
"Service": "mongodb",
"Region": "cn-beijing"
},
"Result": {
"Accounts": [
{
"AccountDesc": "root_account",
"AccountName": "root",
"AccountPrivileges": [
{
"DBName": "admin",
"RoleName": "root"
}
],
"AccountType": "Super",
"AuthDB": "admin",
"CreateTime": "2024-08-09T09:24:56Z",
"ModifyTime": "2024-08-09T09:24:56Z"
},
{
"AccountDesc": "testdesc",
"AccountName": "apitest",
"AccountPrivileges": [
{
"DBName": "admin",
"RoleName": "readAnyDatabase"
},
{
"DBName": "config",
"RoleName": "read"
},
{
"DBName": "local",
"RoleName": "read"
}
],
"AccountType": "UserAdmin",
"AuthDB": "admin",
"CreateTime": "2024-08-09T19:18:51Z",
"ModifyTime": "2024-08-09T19:18:51Z"
},
{
"AccountDesc": "testdesc",
"AccountName": "testacc",
"AccountPrivileges": [
{
"DBName": "config",
"RoleName": "read"
},
{
"DBName": "local",
"RoleName": "read"
}
],
"AccountType": "Normal",
"AuthDB": "testdb",
"CreateTime": "2024-08-09T19:18:51Z",
"ModifyTime": "2024-08-12T11:40:27Z"
}
],
"Total": 3
}
}
错误码
最近更新时间：2026.06.17 16:11:25
这个页面对您有帮助吗？
有用
有用
无用
无用