Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Database Management/ Creating a Database
Updated on 2025-10-21 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating a Database

Function

This API is used to create a database for a TaurusDB instance. Before calling this API:

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependency

    gaussdbformysql:database:create

    Write

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:database:create

    -

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

databases

Yes

Array of CreateGaussMySqlDatabase objects

Definition

Database list.

Constraints

The list can contain a maximum of 50 databases.
Table 4 CreateGaussMySqlDatabase

Parameter

Mandatory

Type

Description

name

Yes

String

Definition

Database name.

Constraints

N/A

Range

The database name can contain 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. The total number of hyphens (-) cannot exceed 10.

Default Value

N/A

comment

No

String

Definition

Database description.

Constraints

N/A

Range

The value can consist of up to 512 characters. It cannot contain carriage returns or any of the following special characters: !<"='>&

Default Value

N/A

character_set

Yes

String

Definition

Character set used by the database.

Constraints

N/A

Range

  • utf8: UTF-8 character set, which uses one to three bytes per character.

  • latin1: It contains 256 characters, which are the ASCII characters plus 128 common Western European characters. It uses 1 byte per character.

  • utf8mb4: complete UTF-8 character set, which uses one to four bytes per character. It can represent more characters, including some special characters and emojis.

Default Value

N/A

users

No

Array of GaussMySqlDatabaseUser objects

Definition

List of database users. When you create a database, you can grant the database permissions to the users in the list. To grant database permissions to a database user, call the API (Granting Permissions to a Database User).

Constraints

If there is no database user in the list, you cannot grant the database permissions to database users when creating a database. The list can contain a maximum of 50 database users.
Table 5 GaussMySqlDatabaseUser

Parameter

Mandatory

Type

Description

name

Yes

String

Definition

Database username.

Constraints

N/A

Range

The username can consist of 1 to 32 characters. Only letters, digits, and underscores (_) are allowed.

Default Value

N/A

host

Yes

String

Definition

Host IP address.

Constraints

N/A

Range

  • If the value is %, all IP addresses are allowed to access your TaurusDB instance.

  • If the value is 10.10.10.%, all IP addresses in the subnet 10.10.10.X are allowed to access your TaurusDB instance.

  • To specify multiple IP addresses, separate them with commas (,), for example, 192.168.0.1,172.16.213.9 (no spaces before or after the comma).

Default Value

N/A

readonly

Yes

Boolean

Definition

Whether the permission is read-only.

Constraints

N/A

Range

  • true: read-only

  • false: read/write

Default Value

N/A

Response Parameters

Status code: 201

Table 6 Response body parameter

Parameter

Type

Description

job_id

String

Definition

ID of the task for creating a database.

Range

N/A

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Creating a database (with utf8mb4 as character set and read/write permission)

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/databases
{
  "databases" : [ {
    "name" : "test",
    "comment" : "database_comment",
    "character_set" : "utf8mb4",
    "users" : [ {
      "name" : "gaussdb_mysql_user1",
      "host" : "127.0.0.1",
      "readonly" : false
    } ]
  } ]
}

Example Response

Status code: 201

Success.

{
  "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Database Management