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.

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 contains 1 to 63 characters, including letters, digits, and underscores (_). It cannot start with pg or a digit and must be different from system usernames.

System users include rdsAdmin, rdsMetric, rdsBackup, rdsRepl, rdsProxy, and rdsDdm.

password

Yes

String

Specifies the password of the database account.

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 cannot contain the username or the username spelled backwards.

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

Example Request

Creating a database account named rds

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

{
    "name": "rds",
    "password": "****"
}

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.