CreateAccount - 创建PolarDB数据库账号

更新时间:
复制 MD 格式

创建PolarDB数据库账号。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

DBClusterId

string

集群 ID。

pc-**************

AccountName

string

账号名称,需符合如下要求:

  • 以小写字母开头,以字母或数字结尾。

  • 由小写字母、数字或下划线组成。

  • 长度为 2~16 个字符。

  • 不能使用某些预留的用户名,如 root、admin 等。

testacc

AccountPassword

string

账号密码,需符合如下要求:

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

  • 长度为 8~32 个字符。

  • 特殊字符为!@#$%^&*()_+-=

Test1111

AccountType

string

账号类型,取值范围如下:

  • Normal:普通账号。

  • Super:高权限账号。

  • DynamoDB:DynamoDB 账号。

说明
  • 若该参数留空,则默认创建 Super 账号。

  • 当集群为 PolarDB PostgreSQL 版(兼容 Oracle)或 PolarDB PostgreSQL 版时,每个集群允许创建多个高权限账号,高权限账号相比普通账号拥有更多权限,创建数据库账号详情参见创建数据库账号

  • 当集群为 PolarDB MySQL 版时,每个集群最多只允许创建 1 个高权限账号,高权限账号相比普通账号拥有更多权限,创建数据库账号详情参见创建数据库账号

  • DynamoDB 账号是为 PolarDB PostgreSQL 版 DynamoDB 兼容功能创建的专用账号,详情参见 DynamoDB 使用说明

Normal

AccountDescription

string

账号备注说明,需满足如下要求:

  • 不能以http://https://开头。

  • 长度为 2~256 个字符。

testdes

DBName

string

允许目标账号访问的数据库名称,支持传入多个数据库名称,多个数据库名称间用英文逗号(,)分隔。

说明

仅 PolarDB MySQL 版集群的普通账号支持该参数。

testdb

AccountPrivilege

string

账号权限,取值范围如下:

  • ReadWrite:读写

  • ReadOnly:只读

  • DMLOnly:只允许 DML

  • DDLOnly:只允许 DDL

  • ReadIndex:只读+索引

说明
  • 必须要传入DBName参数,AccountPrivilege才能生效。

  • 若为DBName参数传入了多个数据库名称,您需要为目标数据库分别授予相应的权限,多个账号权限之间使用英文逗号(,)分隔,且需保证AccountPrivilege的字符串长度不超过 900。例如,需要授权数据库 DB1 读写权限,授权数据库 DB2 只读权限,您需要设置DBNameDB1,DB2,并设置AccountPrivilegeReadWrite,ReadOnly

  • 仅 PolarDB MySQL 版集群的普通账号支持设置该参数。

ReadWrite

ClientToken

string

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,保证在不同请求间唯一,大小写敏感、不超过 64 个 ASCII 字符。

6000170000591aed949d0f54a343f1a4233c1e7d1c5c******

PrivForAllDB

string

是否授权当前集群所有库及后续新增所有库的权限。取值范围如下:

  • 0 或不填:不授权。

  • 1:授权。

说明
  • 必须要传入AccountPrivilege参数才能生效。

  • 当参数设置为1时,表示AccountPrivilege会被授权到所有的库。

0

NodeType

string

节点类型。取值范围:

  • Search:PolarDB Search 节点账号时需要传入

Search

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

CED079B7-A408-41A1-BFF1-EC608E******

示例

正常返回示例

JSON格式

{
  "RequestId": "CED079B7-A408-41A1-BFF1-EC608E******"
}

异常返回示例

JSON格式

{
   "RequestId": "2FED790E-FB61-4721-8C1C-07C627FA5A19"
}

错误码

HTTP status code

错误码

错误信息

描述

400 LockTimeout The request processing has failed due to lock timeout. 由于锁定超时,请求处理失败
400 EngineMigration.ActionDisabled Specified action is disabled while custins is in engine migration. custins处于引擎迁移中时,指定的操作被禁用
400 InvalidAccountPassword.Malformed The specified parameter AccountPassword is not valid. 指定的参数AccountPassword无效。
400 InvalidAccountType.Malformed The specified parameter AccountType is not valid. 指定的参数AccountType无效。
400 InvalidAccountDescription.Malformed The specified parameter AccountDescription is not valid. 指定的参数AccountDescription无效。
400 InvalidAccountPrivilege.Malformed The specified parameter AccountPrivilege is not valid. 指定的参数AccountPrivilege无效。
400 InvalidAccountName.Malformed The specified parameter AccountName is not valid. 指定的参数AccountName无效。
404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. 当前的记录中不存在提供的 DBClusterId。
404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. 指定的参数DBClusterId无效

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

变更历史

更多信息,参考变更详情