调用CreateDatabase创建PolarDB集群数据库-云原生数据库 PolarDB-阿里云

为PolarDB集群创建一个新的数据库。

接口说明

集群必须满足以下条件，否则将创建失败：

当前集群状态：运行中。
当前集群锁定模式：正常。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
polardb:CreateDatabase	create	*DBCluster `acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}`	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。	pc-**************
DBName	string	是	数据库名称，名称需满足如下要求：由小写字母、数字、中划线（-）、下划线（_）组成。以字母开头，以字母或数字结尾，最长 64 个字符。说明下划线（_）占 2 个字符。请勿使用保留关键字作为数据库名称，如`test`、`mysql`等。	testDB
CharacterSetName	string	是	字符集。关于字符集的取值范围，请参见字符集表。	utf8
DBDescription	string	否	数据库备注信息，备注信息需满足如下要求：不能以`http://`或`https://`开头。长度为 2~256 个字符。说明当集群为 PolarDB PostgreSQL 版（兼容 Oracle）或 PolarDB PostgreSQL 版时，该参数必填；当集群为 PolarDB MySQL 版时，该参数非必填。	testdesc
AccountName	string	否	授权访问该数据库的账号名。可通过接口 DescribeAccounts 查询账号信息。说明只支持输入普通账号，高权限账号默认拥有数据库全部权限无需授权。当集群为 PolarDB PostgreSQL 版（兼容 Oracle）或 PolarDB PostgreSQL 版时，该参数必填；当集群为 PolarDB MySQL 版时，该参数非必填。	testacc
AccountPrivilege	string	否	账号权限，取值范围如下： ReadWrite：读写。 ReadOnly：只读。 DMLOnly：只允许 DML。 DDLOnly：只允许 DDL。 ReadIndex：只读+索引。若该参数不填，则默认为 ReadWrite。说明该参数仅当 AccountName 为非空值时生效。当集群为 PolarDB PostgreSQL 版（兼容 Oracle）或 PolarDB PostgreSQL 版时，该参数非必填；当集群为 PolarDB MySQL 版时，该参数非必填。若指定了 AccountName，则创建的 DB 的 Owner 为该账号。	ReadWrite
Collate	string	否	语言环境设置，用于指定新建数据库的排序规则。说明语言环境必须与 CharacterSetName 参数设置的字符集兼容。当集群为 PolarDB PostgreSQL 版（兼容 Oracle）或 PolarDB PostgreSQL 版时，该参数必填；当集群为 PolarDB MySQL 版时，该参数非必填。关于该参数的取值范围，请登录 PolarDB 控制台，在配置与管理 > 数据库管理页签，单击创建数据库进行查看。	C
Ctype	string	否	语言环境设置，用于指定数据库的字符分类。说明语言环境必须与 CharacterSetName 参数设置的字符集兼容。与 Collate 传入信息一致。当集群为 PolarDB PostgreSQL 版（兼容 Oracle）或 PolarDB PostgreSQL 版时，该参数必填；当集群为 PolarDB MySQL 版时，该参数非必填。关于该参数的取值范围，请登录 PolarDB 控制台，在配置与管理 > 数据库管理页签，单击创建数据库进行查看。	C

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	93E98F25-BE02-40DA-83E3-F77F8D******

示例

正常返回示例

JSON格式

{
  "RequestId": "93E98F25-BE02-40DA-83E3-F77F8D******"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidDBName.Malformed	The specified parameter DBName is not valid.	操作失败，指定的数据库名称格式无效。
400	Database.AddError	Instance %s add database minidoc error	实例%s添加数据库minidoc错误
400	InvalidDBDescription.Malformed	The specified parameter DBDescription is not valid.	指定的参数DBDescription无效。
400	InvalidAccountPrivilege.Malformed	The specified parameter AccountPrivilege is not valid.	指定的参数AccountPrivilege无效。
400	InvalidAccountName.Malformed	The specified parameter AccountName is not valid.	指定的参数AccountName无效。
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	当前的记录中不存在提供的DBClusterId。
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	指定的参数DBClusterId无效
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	当前的记录中不存在提供的DBClusterId。

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

变更历史

变更时间	变更内容概要	操作
2023-09-12	OpenAPI 错误码发生变更	查看变更详情