调用 CreateAccount 接口,为指定的云数据库 MongoDB 版实例创建数据库账号,并可为账号授予一个或多个数据库角色权限。
接口说明
支持云盘版与本地盘版实例,架构上支持副本集与分片集群。
账号采用「不落库」架构,账号信息实时读自实例;创建过渡期内账号未建成前不会出现在 DescribeAccounts 列表中,建成后直接以
Available状态出现。同一实例内「账号名 + 所在库(DBName)」唯一,创建重复账号会被拒绝。
账号名禁止使用系统保留名
root(忽略大小写)与保留前缀__cloud。Roles的必填性与实例架构相关:副本集、分片集群 ConfigServer(cs)账号必填;分片集群 Shard 直连(db)账号禁止传入(传入报InvalidRoles.NotSupported)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dds:CreateAccount |
create |
*DBInstance
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DBInstanceId |
string |
是 |
实例 ID。分片集群实例请传入分片集群 ID,账号操作以 config server 视角执行。 |
dds-uf6e9433e955xxxx |
| AccountName |
string |
是 |
账号名称。
|
admin1 |
| AccountPassword |
string |
是 |
账号密码。
说明
特殊字符的处理方法,请参见如何解决连接串中账号密码包含特殊字符导致连接失败的问题? |
Test123456! |
| CharacterType |
string |
否 |
账号类型。 枚举值:
|
db |
| Roles |
array<object> |
否 |
账号授权角色列表。副本集 / cs 账号必填;分片 db 直连账号禁止传入。
|
|
|
object |
否 |
账号授权角色 |
||
| DBName |
string |
否 |
账号所在库(鉴权库)。 |
admin |
| Role |
string |
否 |
角色名称。可以是内置角色或实例上已创建的自定义角色,取值规则请参见 Roles 参数描述。 |
read |
| DBName |
string |
否 |
账号所在库(鉴权库)。 |
admin |
| AccountDescription |
string |
否 |
账号备注。
|
test |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 id。 |
7FEF1BEF-2842-5758-9126-415A297XXXXX |
| TaskId |
integer |
任务 ID |
123456 |
示例
正常返回示例
JSON格式
{
"RequestId": "7FEF1BEF-2842-5758-9126-415A297XXXXX",
"TaskId": 123456
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidAccountName.Malformed | Specified parameter AccountName is not valid. | 指定的参数AccountName无效。 |
| 400 | InvalidAccountPassword.Malformed | Specified parameter AccountPassword is not valid. | 指定的参数AccountPassword无效。 |
| 400 | InvalidAccountDescription.Malformed | Specified parameter AccountDescription is not valid. | 指定的参数AccountDescription无效。 |
| 404 | AccountLimitExceeded | AccountQuotaExceeded: Exceeding the allowed amount of account. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。