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

Creating a Database Account

Function

This API is used to create a database account for 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.
  • If you want to call this API repeatedly to create database accounts for your DB instance, call it in serial.
  • 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}/db_user

  • 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 username of the database account.

The username consists of 1 to 32 characters. Only lowercase letters, digits, hyphens (-), and underscores (_) are allowed.
  • If the database version is MySQL 5.6, the username consists of 1 to 16 characters.
  • If the database version is MySQL 5.7 or 8.0, the username consists of 1 to 32 characters.

password

Yes

String

Specifies the password of the database account.

Valid value:

The value must be 8 to 32 characters long and contain at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters (~!@#$%^*-_=+?,()&). The value must be different from the account name or account name spelled backwards.

You are advised to enter a strong password to improve security, preventing security risks such as brute force cracking.

comment

No

String

Specifies remarks of the database account.

The parameter must be 1 to 512 characters long and is supported only for MySQL 8.0.25 and later versions.

hosts

No

Array of strings

IP addresses that are allowed to access your DB instance.
  • If the IP address is set to %, all IP addresses are allowed to access your instance.
  • If the IP address is set to 10.10.10.%, all IP addresses in the subnet 10.10.10.X are allowed to access your instance.
  • Multiple IP addresses can be added.

databases

No

Array of objects

Databases that you can log in using the account. For details, see Table 3.

Table 3 databases element structure description

Parameter

Mandatory

Type

Description

name

Yes

String

Database name.

readonly

No

Boolean

Whether the database is read-only.

  • true: indicates the database is read-only.
  • false: indicates the database is readable and writable.

Example Request

Creating a database account named rds

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

{
    "name": "rds",
    "password": "************",
    "comment": "mysql",
    "hosts": [
        "%"  
    ],
    "databases" : [
       {
           "name" : "***",
            "readonly" : false
       }
    ]
}

Response

  • Normal response
    Table 4 Parameter description

    Name

    Type

    Description

    resp

    String

    Returns successful if the invoking is successful.

Status Code

Error Code

For details, see Error Codes.