Creates a database for a PolarDB cluster.
Operation description
Before you call this operation, make sure that the following requirements are met:
- The cluster is in the Running state.
- The cluster is unlocked.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
polardb:CreateDatabase | create |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBClusterId | string | Yes | The ID of cluster. | pc-************** |
DBName | string | Yes | The name of the database. The name must meet the following requirements:
Note
Do not use reserved words as database names, such as test or mysql .
| testDB |
CharacterSetName | string | Yes | The character set that is used by the cluster. For more information, see Character set tables. | utf8 |
DBDescription | string | No | The description of the database. The description must meet the following requirements:
Note
This parameter is required for a PolarDB for Oracle or PolarDB for PostgreSQL cluster. This parameter is optional for a PolarDB for MySQL cluster.
| testdesc |
AccountName | string | No | The name of the account that is authorized to access the database. You can call the DescribeAccounts operation to query account information. Note
| testacc |
AccountPrivilege | string | No | The permissions that are granted to the account. Valid values:
If you leave this parameter empty, the default value ReadWrite is used. Note
| ReadWrite |
Collate | string | No | The language that defines the collation rules in the database. Note
| C |
Ctype | string | No | The language that indicates the character type of the database. Note
To view the valid values for this parameter, perform the following steps: Log on to the PolarDB console and click the ID of a cluster. In the left-side navigation pane, choose Settings and Management > Databases. Then, click Create Database. | C |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "93E98F25-BE02-40DA-83E3-F77F8D******"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidDBName.Malformed | The specified parameter DBName is not valid. | The format of the specified database name is invalid. |
400 | Database.AddError | Instance %s add database minidoc error | Failed to add database minidoc to cluster %s. |
400 | InvalidDBDescription.Malformed | The specified parameter DBDescription is not valid. | The specified DBDescription parameter is invalid. |
400 | InvalidAccountPrivilege.Malformed | The specified parameter AccountPrivilege is not valid. | The specified AccountPrivilege parameter is invalid. |
400 | InvalidAccountName.Malformed | The specified parameter AccountName is not valid. | The specified AccountName parameter is invalid. |
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | The specified DBClusterId parameter does not exist in the current record. |
404 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | The specified DBClusterId parameter is invalid. |
404 | InvalidDBClusterId.NotFound | The DBInstanceId provided does not exist in our records. | The specified DBClusterId parameter does not exist in the current record. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2023-09-12 | The Error code has changed | View Change Details |