调用 CreateDBAccount 接口为目标 MongoDB 实例创建账号。

请求类型

同步请求。

注意事项

仅支持创建高权限账号（即 AccountType 为 UserAdmin ）和普通账号（即 AccountType 为 Normal ）。关于不同类型账号的更多详情，请参见账号类型。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

InstanceId String 必选示例值：mongo-replica-7e0f61909ce5

实例 ID。

说明

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

AccountName String 必选示例值：apitest

账号名称。名称需同时满足如下要求：

长度为 1~32 个字符。

由大小写字母、数字、下划线（_）、中划线（-）组成。

以字母开头，字母或数字结尾。

账号名称不允许与如下任意一个系统预留账号的名称重复：root、system_inspector、__system、mgr。

例如，您可以将账号名称设置为 test__system 或 __system__test，但不允许设置为 __system。

说明

除 root 账号外，上述系统预留账号均不会在 MongoDB 控制台上展示。更多详情，请参见查看账号信息。

您无需关注这些系统预留账号的权限或操作，强烈建议不要对这些预留账号进行任何修改、删除或重命名操作，否则会影响数据库账号正常运行。

账号名称不允许以 vedb_mongodb_ 开头。

例如，您可以将账号名称设置为 testvedb_mongodb_，但不允许设置为 vedb_mongodb_test。

AccountPassword String 必选示例值：Pwd@123456

账号密码。密码需同时满足如下要求：

只能为大小写字母、数字及以下特殊字符 _#!@$%^&*()+=-。

长度为 8~32 个字符。

至少包含大写字母、小写字母、数字或特殊字符中的任意三种。

不允许使用极易被破解的弱密码（如 Admin@123）。

说明

若您在密码中使用了特殊字符，在连接实例时可能需要对特殊字符进行转义。更多详情，请参见需要转义的特殊字符。

您也可以在账号创建后，通过 ResetDBAccount 接口来修改账号的密码。

关于 MongoDB 中禁止使用的弱密码详情，请参见弱密码列表。

AuthDB String 可选示例值：admin

账号所属的目标数据库。

说明

若不设置该参数，新建账号将默认属于 admin库。

AccountDBPrivileges Object[] 可选示例值：

账号所授予的数据库及权限列表。

说明

若不设置该参数，默认不会为账号授予任何数据库的任何权限。

DBName String 必选示例值：admin

需要为账号授予权限的数据库名称。

文档数据库 MongoDB 版允许为部分系统库以及您的自建数据库授予相关权限，因此允许传入的数据库取值如下：

系统库：包括 admin、local 和 config。

其他数据库：即您自行创建的任意数据库，例如 testdb。

说明

关于不同类型数据库允许授予的权限详情，请参见数据库与账号权限。

您可以通过 listDatabases命令查看当前 MongoDB 实例中的数据库名称。

RoleNames String[] 必选示例值：read

需要为账号授予的数据库权限。

文档数据库 MongoDB 版对不同数据库允许授予的权限如下：

admin 库：允许为账号在 admin 库中授予 read、userAdmin、readAnyDatabase、

readWriteAnyDatabase、userAdminAnyDatabase、dbAdminAnyDatabase、clusterMonitor 和 backup 权限。

local 库：仅允许为账号在 local 库中授予 read 权限。

config 库：仅允许为账号在 config 库中授予 read 权限。

其他数据库：允许为账号在您自行创建的数据库中授予 read、readWrite、dbAdmin、userAdmin 和 dbOwner 权限。

说明

允许同时传入多个权限，多个权限间用英文逗号（,）分隔。

关于不同类型数据库允许授予的权限详情，请参见数据库与账号权限。

AccountDesc String 可选示例值：testdesc

账号的备注信息。备注信息需同时满足如下条件：

长度为 0~256 个字符。

可以包含数字、中文、英文、下划线（_）、短横线（-）。

说明

若不设置该参数，账号备注信息默认为空。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

示例

请求示例

在 admin 数据库中创建一个拥有如下权限的数据库账号：

拥有 admin 库的 read、userAdmin、readAnyDatabase、readWriteAnyDatabase、userAdminAnyDatabase、dbAdminAnyDatabase、clusterMonitor 和 backup 权限。

拥有 local 库的 read 权限。

拥有 config 库的 read 权限。

拥有自建数据库 testdb 的 read、readWrite、dbAdmin、userAdmin 和 dbOwner 权限。

返回示例

错误码

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