Updated on 2024-06-07 GMT+08:00

Creating a Database

Function

This API is used to create a database in a specified DB instance.

  • Before calling an API, you need to understand the API in Authentication.

Constraints

  • This operation cannot be performed when the DB instance is in any of the following statuses: creating, changing instance class, changing port, frozen, or abnormal.
  • For any database and account created using methods other than the RDS console and APIs, if the database name and account name do not meet the database naming rules (see Table 2) and account naming rules (see Table 2), for example, containing Chinese characters or unsupported special characters, the database and account cannot be managed through the RDS console or APIs.
  • In migration scenarios, if any database name and account name of the source database do not meet the database naming rules (see Table 2) and account naming rules (see Table 2), the database and account cannot be managed through the RDS console or APIs after being migrated to the destination RDS for MySQL database.

URI

  • URI format

    POST /v3/{project_id}/instances/{instance_id}/database

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    instance_id

    Yes

    Specifies the DB instance ID.

Request

Table 2 Parameter description

Name

Mandatory

Type

Description

name

Yes

String

Specifies the database name.

The database name can contain 1 to 64 characters. Only letters, digits, hyphens (-), underscores (_), and dollar signs ($) are allowed. The total number of hyphens (-) and dollar signs ($) cannot exceed 10. RDS for MySQL 8.0 does not support dollar signs ($).

character_set

Yes

String

Specifies the character set used by the database, such as utf8, gbk, and ascii.

comment

No

String

Specifies the database remarks.

The value can contain 0 to 512 characters.

NOTE:
  • To use this function, contact customer service to apply for the required permissions.
  • This parameter takes effect only for kernel versions 5.6.51.3 or later, 5.7.33.1 or later, and 8.0.25.1 or later. If your kernel version does not meet the requirements, upgrade the kernel to the latest version by referring to Upgrading a Minor Version.

Example Request

Create a database named rds-test.

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/database

{
    "name": "rds-test",
    "character_set": "utf8",
    "comment":"comment"
}

Response

  • Normal response
    Table 3 Parameter description

    Name

    Type

    Description

    resp

    String

    Returns successful if the invoking is successful.

Status Code

Error Code

For details, see Error Codes.