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

文档中心

立即注册

导航

DeleteDBAccount

最近更新时间：2024.12.12 21:46:14首次发布时间：2024.12.04 11:23:22

调用 DeleteDBAccount 接口删除目标 MongoDB 实例中的指定账号。

请求类型

同步请求。

注意事项

仅支持删除高权限账号（即 AccountType 为 UserAdmin ）和普通账号（即 AccountType 为 Normal ），不允许删除超级管理员账号（即 AccountType 为 Super）。关于不同类型账号的更多详情，请参见账号类型。
账号删除后不可恢复，并且可能会导致使用该账号的连接中断，请谨慎操作。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mongo-replica-7e0f6190****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。
AccountName	String	是	apitest	需要删除的账号名称。说明您可以调用 DescribeDBAccounts 接口查询目标 MongoDB 实例下的所有账号信息，包括账号名称。
AuthDB	String	否	testdb	账号所属的数据库。说明若不设置该参数，默认需要删除的账号属于 admin 库。

返回参数

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

示例

请求示例

删除 testdb 库中 apitest 账号。

POST https://mongodb.volcengineapi.com/?Action=DeleteDBAccount&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-7e0f6190****",
    "AccountName": "apitest",
    "AuthDB": "testdb"
}

返回示例

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

错误码

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