调用 ResetDBAccount 接口修改目标 MongoDB 实例中指定账号的密码或将 root 账号的权限重置为出初始状态。

请求类型

同步请求。

注意事项

账号类型不同，支持通过 ResetDBAccount 接口修改的信息也不同。其中：

高权限账号（即 AccountType 为 UserAdmin ）和普通账号（即 AccountType 为 Normal ）

支持通过当前接口修改高权限账号或普通账号的密码。更多关于不同类型账号的更多详情，请参见账号类型。

您可以通过 UpdateDBAccountPrivilege 接口修改高权限账号或普通账号的数据库权限和账号描述。更多详情，请参见修改账号权限。

超级管理员账号（即 AccountType 为 Super ）：

支持通过当前接口修改超级管理员的密码，或将权限重置为出初始状态（即补全超级管理员账号允许被授予的权限）。关于超级管理员账号允许授予的完整权限详情，请参见数据库与账号权限。

您可以通过 UpdateDBAccountPrivilege 接口修改超级管理员账号的账号描述。

修改密码可能导致正在使用 root 账号的数据库连接中断，请谨慎操作。

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

调试

API Explorer

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

去调试

请求参数

InstanceId String 必选示例值：mongo-replica-e405f8e2f8e2

实例 ID。

说明

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

AccountName String 必选示例值：testacc

数据库账号名称。

说明

您可以调用 DescribeDBAccounts接口查询目标实例下的账号信息，包括账号名称。

AuthDB String 可选示例值：testdb

账号所属的数据库。

说明

若不设置该参数，默认需要修改密码的账号属于 admin 库。

AccountPassword String 必选示例值：Test@123456

数据库账号的密码。密码需同时满足如下要求：

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

长度为 8~32 个字符。

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

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

说明

修改密码可能导致正在使用当前账号的数据库连接中断，请谨慎操作。

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

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

ResetDBAccount Boolean 可选示例值：false

是否将 root 账号的权限重置为出初始状态（即补全超级管理员账号允许被授予的权限）。取值范围如下：

false（默认值）：不重置。

true：重置。

说明

该参数仅对 admin 库中的 root 账号（即 AuthDB 为 admin 且 AccountName 为 root）生效。

关于超级管理员账号允许授予的完整权限详情，请参见数据库与账号权限。

返回参数

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

示例

请求示例 1

修改 testdb 中 testacc 账号的密码为 Test@12****。

返回示例 1

请求示例 2

修改 admin 库中 root 账号的密码为 Pwd@12****，且将 root 账号的权限重置为初始状态。

返回示例 2

错误码

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

文档数据库 MongoDB 版