All Products
Search
Document Center

ApsaraDB RDS:CreateDatabase

Last Updated:Apr 17, 2024

Creates a database in an ApsaraDB RDS instance.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server
  • MariaDB

References

Note Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
rds:CreateDatabaseWRITE
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID. You can call the DescribeDBInstances operation to query the ID of the instance.

rm-uf6wjk5xxxxxxxxxx
DBNamestringYes

The name of the database.

Note
  • The name must be 2 to 64 characters in length.
  • The name must start with a lowercase letter and end with a lowercase letter or digit.
  • The name can contain lowercase letters, digits, underscores (_), and hyphens (-).
  • The name must be unique within the instance.
  • For more information about invalid characters, see Forbidden keywords table.
  • rds_mysql
    CharacterSetNamestringYes

    The character set.

    • Valid values for MySQL or MariaDB databases: utf8, gbk, latin1, and utf8mb4

    • Valid values for SQL Server databases: Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS, and Chinese_PRC_BIN

    • Valid values for PostgreSQL databases: a value in the Character set,<Collate>,<Ctype> format. Example: UTF8,C,en_US.utf8.

      • Valid values for the character set: KOI8U, UTF8, WIN866, WIN874, WIN1250, WIN1251, WIN1252, WIN1253, WIN1254, WIN1255, WIN1256, WIN1257, WIN1258, EUC_CN, EUC_KR, EUC_TW, EUC_JP, EUC_JIS_2004, KOI8R, MULE_INTERNAL, LATIN1, LATIN2, LATIN3, LATIN4, LATIN5, LATIN6, LATIN7, LATIN8, LATIN9, LATIN10, ISO_8859_5, ISO_8859_6, ISO_8859_7, ISO_8859_8, and SQL_ASCII
      • Valid values for the Collate field: You can execute the SELECT DISTINCT collname FROM pg_collation; statement to obtain the field value. The default value is C.
      • Valid values for the Ctype field: You can execute the SELECT DISTINCT collctype FROM pg_collation; statement to obtain the field value. The default value is en_US.utf8.
    gbk
    DBDescriptionstringNo

    The description of the database. The description must be 2 to 256 characters in length and can contain letters, digits, underscores (_), and hyphens (-). The description must start with a letter.

    Note The value cannot start with http:// or https://.
    Database for testing
    ResourceGroupIdstringNo

    The ID of the resource group.

    rg-acfmy*****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The ID of the request.

    5A77D650-27A1-4E08-AD9E-59008EDB6927

    Examples

    Sample success responses

    JSONformat

    {
      "RequestId": "5A77D650-27A1-4E08-AD9E-59008EDB6927"
    }

    Error codes

    HTTP status codeError codeError messageDescription
    400EngineMigration.ActionDisabledSpecified action is disabled while custins is in engine migration.The specified operation is disabled when the instance is being migrated across engines.
    400Database.ConnectErrorDatabase connect error. please check instance status and database processlistA database connection error occurred. Check the instance state and the database connection pool.
    400InvalidDescription.FormatSpecified description is not valid.The description is invalid.
    400InvalidDBName.ForbidSpecified DB name is a keyword in RDS.Failed to specify the database name. The database name cannot contain the forbidden keyword DBName. Modify the database name.
    400InvalidAccountName.ForbidSpecified account name is a keyword in RDS.The username is invalid. Forbidden keywords cannot be used for a username. Modify the username.
    400InvalidAccountPrivilege.MalformedSpecified account privilege is not valid.Your account does not have the required permissions.
    400IncorrectDBInstanceServiceTypeCurrent DB instance top type does not support this operation.-
    400Database.AddErrorCreate Db failed, please check input value and instance status.Failed to create the database. Check the specified parameters and the instance status.
    400Database.QueryErrorinvalid value, may include special character.The value is invalid and may contain special characters.
    400SqlExcutionFailedDue to the limit number you can't create a database.-
    400InvalidDBName.DuplicateSpecified DB name already exists in the This instance.A database with the same name has been created on the RDS instance. Specify a different name.
    404InvalidDBInstanceName.NotFoundThe database instance does not exist.The name of the RDS instance cannot be found. Check the name of the RDS instance.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-11-21The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 404
    2023-09-08The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 404
    2023-04-03The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 404
    2023-03-24The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 404
    2022-10-28The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Added Error Codes: 404
    2022-06-23API Description Update. The Error code has changedsee changesets
    Change itemChange content
    API DescriptionAPI Description Update.
    Error CodesThe Error code has changed.
      delete Error Codes: 400