You need to enable JavaScript to run this app.
导航
文档数据库 MongoDB 版
  • 文档首页
    • /
  • 文档数据库 MongoDB 版

DescribeDBAccounts

最近更新时间：2023.08.07 18:52:29

首次发布时间：2022.04.12 11:06:53

我的收藏

调用 DescribeDBAccounts 接口查询目标实例下的账号信息。

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述

InstanceId

String

是

mongo-replica-e405f8e2****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。

AccountNameString否root数据库账号名称。当前仅支持查看 root 账号的信息。
PageNumberInteger否1实例信息列表的页码，默认值为 1。取值为不超过 Integer 数据类型的最大值，起始值为 1。
PageSizeInteger否10每页记录数，默认值为 10。

返回数据

名称类型示例值描述
AccountsArray of AccountObject请参见返回示例。账号信息列表。关于 Accounts 的详细说明，请参见数据结构。
TotalInteger1所有账号的数量。

请求示例

POST https://mongodb.volcengineapi.com/?Action=DescribeDBAccounts&Version=2022-01-01 HTTP/1.1
Host: mongodb.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****",
    "AccountName":"root"
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220308144759010212168072140B****",
        "Action": "DescribeDBAccounts",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": {
        "Accounts": [
            {
                 "AccountName": "root",
                 "AccountPrivileges": [
                     {
                         "DBName": "admin",
                         "RoleName": "root"
                     }
                 ],
                 "AccountType": "Super"
            }
        ],
        "Total": 1
    }
}