DescribeDBAccounts--文档数据库 MongoDB 版-火山引擎

文档中心

立即注册

导航

DescribeDBAccounts

最近更新时间：2024.08.15 20:42:30首次发布时间：2022.04.12 11:06:53

调用 DescribeDBAccounts 接口查询目标 MongoDB 实例下的账号列表。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mongo-replica-e405****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。
AccountName	String	否	apitest	数据库账号名称。支持模糊查询。说明若不设置该参数，表示不使用账号名称条件进行筛选。
AuthDB	String	否	admin	账号所属的数据库。支持模糊查询。说明若不设置该参数，表示不使用账号所属的数据库条件进行筛选。
PageSize	Integer	否	10	每页记录数，取值为 1~1000 间的整数，默认值为 10。
PageNumber	Integer	否	1	实例信息列表的页码，默认值为 1。取值为不超过 Integer 数据类型的最大值，起始值为 1。

返回参数

参数	类型	示例值	描述
Total	Integer	3	账号总数。
Accounts	Object[]		账号信息列表。

示例

请求示例

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-e405****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202408121638361440F7C1887001035215-fe****",
        "Action": "DescribeDBAccounts",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-guilin-boe"
    },
"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
    }
}

错误码

更多详情，请参见错误码。