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

文档中心

立即注册

导航

ResetDBAccount

最近更新时间：2024.10.17 14:42:41首次发布时间：2022.04.12 11:06:53

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

请求类型

同步请求。

注意事项

账号类型不同，支持通过 ResetDBAccount 接口修改的信息也不同。其中：
- 高权限账号（即 AccountType 为 UserAdmin ）和普通账号（即 AccountType 为 Normal ）
  支持通过当前接口修改高权限账号或普通账号的密码。更多关于不同类型账号的更多详情，请参见账号类型。
- 超级管理员账号（即 AccountType 为 Super ）：
  支持通过当前接口修改超级管理员的密码，或将权限重置为出初始状态（即补全超级管理员账号允许被授予的权限）。关于超级管理员账号允许授予的完整权限详情，请参见数据库与账号权限。
修改密码可能导致正在使用 root 账号的数据库连接中断，请谨慎操作。
若您在密码中使用了特殊字符，在连接实例时可能需要对特殊字符进行转义。更多详情，请参见需要转义的特殊字符。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mongo-replica-e405f8e2****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。
AccountName	String	是	testacc	数据库账号名称。说明您可以调用 DescribeDBAccounts 接口查询目标实例下的账号信息，包括账号名称。
AuthDB	String	否	testdb	账号所属的数据库。说明若不设置该参数，默认需要修改密码的账号属于 admin 库。
AccountPassword	String	是	Test@12****	数据库账号的密码。密码需同时满足如下要求：长度为 8~32 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意三种。支持的特殊字符为： `_#!@$%^&*()+=-`。说明修改密码可能导致正在使用当前账号的数据库连接中断，请谨慎操作。若您在密码中使用了特殊字符，在连接实例时可能需要对特殊字符进行转义。更多详情，请参见需要转义的特殊字符。
ResetDBAccount	Boolean	否	false	是否将 root 账号的权限重置为出初始状态（即补全超级管理员账号允许被授予的权限）。取值范围如下： `false`（默认值）：不重置。 `true`：重置。说明该参数仅对 admin 库中的 root 账号（即 `AuthDB` 为 `admin` 且 `AccountName` 为 `root`）生效。关于超级管理员账号允许授予的完整权限详情，请参见数据库与账号权限。

返回参数

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

示例

请求示例 1

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

POST https://mongodb.volcengineapi.com/?Action=ResetDBAccount&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": "testacc",
    "AuthDB": "testdb",
    "AccountPassword": "Test@12****"
}

返回示例 1

{
    "ResponseMetadata": {
        "RequestId": "20220309143916010212168103****",
        "Action": "ResetDBAccount",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": null
}

请求示例 2

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

POST https://mongodb.volcengineapi.com/?Action=ResetDBAccount&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",
    "AuthDB": "admin",
    "AccountPassword": "Pwd@12****",
    "ResetDBAccount": true
}

返回示例 2

{
    "ResponseMetadata": {
        "RequestId": "20220309143916010212168103****",
        "Action": "ResetDBAccount",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

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