CreateAccount - 创建账号

更新时间:
复制 MD 格式

调用 CreateAccount 接口,为指定的云数据库 MongoDB 版实例创建数据库账号,并可为账号授予一个或多个数据库角色权限。

接口说明

  • 支持云盘版与本地盘版实例,架构上支持副本集与分片集群。

  • 账号采用「不落库」架构,账号信息实时读自实例;创建过渡期内账号未建成前不会出现在 DescribeAccounts 列表中,建成后直接以 Available 状态出现。

  • 同一实例内「账号名 + 所在库(DBName)」唯一,创建重复账号会被拒绝。

  • 账号名禁止使用系统保留名 root(忽略大小写)与保留前缀 __cloud。

  • Roles 的必填性与实例架构相关:副本集、分片集群 ConfigServer(cs)账号必填;分片集群 Shard 直连(db)账号禁止传入(传入报 InvalidRoles.NotSupported)。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dds:CreateAccount

create

*DBInstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}

无 无

请求参数

名称

类型

必填

描述

示例值

DBInstanceId

string

是

实例 ID。分片集群实例请传入分片集群 ID,账号操作以 config server 视角执行。

dds-uf6e9433e955xxxx

AccountName

string

是

账号名称。

  • 正则:^[a-z]+[a-z0-9|_]*[a-z0-9]+$,即以小写字母开头、以小写字母或数字结尾,中间允许小写字母、数字、下划线(_),总长度 2~16 个字符。

  • 禁止使用保留名 root(忽略大小写,系统自带账号,不可再建同名账号)。

  • 禁止以 __cloud 开头(系统账号保留前缀)。

  • 非法时返回 InvalidAccountName.Malformed。

admin1

AccountPassword

string

是

账号密码。

  • 长度为 8~32 个字符;允许字符为大写字母、小写字母、数字及特殊字符 !@#$%^&*()_+-=。

  • 必须至少包含大写字母、小写字母、数字、特殊字符四类中的三类。

  • 非法时返回 InvalidAccountPassword.Malformed。

Test123456!

CharacterType

string

否

账号类型。
取值:
- normal:副本集账号(副本集实例传任何值均按 normal 处理)
- cs:分片集群 ConfigServer 账号
- db:分片集群 Shard 直连账号(分片实例传 cs 以外的值一律按 db 处理)
默认值:db。













枚举值:

  • cs :

    分片集群 Config Server 账号

  • normal :

    副本集普通数据库账号

  • db :

    分片集群 Shard 直连账号

db

Roles

array<object>

否

账号授权角色列表。副本集 / cs 账号必填;分片 db 直连账号禁止传入。

  • 全局禁止(返回 InvalidRoles.NotAllowed):root、clusterAdmin、hostManager、clusterManager、__system、__queryableBackup、restore。

  • 可授权到任意库(含 admin):read、userAdmin、enableSharding。

  • 仅可授权到非 admin 库(授权到 admin 返回 InvalidRoles.InvalidDB):readWrite、dbAdmin、dbOwner。

  • 仅可授权到 admin 库:readAnyDatabase、readWriteAnyDatabase、userAdminAnyDatabase、dbAdminAnyDatabase、clusterMonitor、backup、alibabaCloudAdmin(alibabaCloudAdmin 仅 4.4 及以上内核版本实例支持,低版本返回 InvalidRoles.NotAllowed)。

  • 自定义角色:上述之外的角色视为自定义角色,须已存在于实例(可通过 DescribeAccountRoles 查询),否则返回 InvalidRoles.NotFound;Roles.N.DBName 必须等于该角色的定义库,否则返回 InvalidRoles.DBNotMatch。

  • Roles 整体缺失返回 MissingRoles;Roles.N.Role 与 Roles.N.DBName 未成对出现返回 InvalidRoles.Malformed;分片 db 直连账号传入 Roles 返回 InvalidRoles.NotSupported。

object

否

账号授权角色

DBName

string

否

账号所在库(鉴权库)。
缺省为 admin。
规则:为空放行(下游按 admin 处理);非空时长度为 1~63 个字符,禁止包含 /、\、.、空格、"、$,且取值不能为 local,非法报 InvalidParameter。




admin

Role

string

否

角色名称。可以是内置角色或实例上已创建的自定义角色,取值规则请参见 Roles 参数描述。

read

DBName

string

否

账号所在库(鉴权库)。
缺省为 admin。
规则:为空放行(下游按 admin 处理);非空时长度为 1~63 个字符,禁止包含 /、\、.、空格、"、$,且取值不能为 local,非法报 InvalidParameter。




admin

AccountDescription

string

否

账号备注。

  • 正则:^[a-zA-Z 一-龥][a-zA-Z 一-龥 0-9_.-]{1,255}$,即以英文字母或汉字开头,后接英文字母、汉字、数字、下划线(_)、英文句点(.)或短划线(-),总长度 2~256 个字符。

  • 非法时返回 InvalidAccountDescription.Malformed。

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.

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。