Updated on 2025-08-20 GMT+08:00

Creating a Database Schema

Function

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

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.

URI

  • URI format

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

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

db_name

Yes

String

Definition

Specifies the database name.

Constraints

N/A

Range

The database name can contain 1 to 63 characters. Only letters, digits, and underscores (_) are allowed. It cannot start with pg or a digit and cannot be the same as RDS for PostgreSQL template database names.

RDS for PostgreSQL template databases include postgres, template0, and template1.

Default Value

N/A

schemas

Yes

Array of objects

Definition

Each element is the schema information associated with the database. A single request supports a maximum of 20 elements.

For details on the element structure, see Table 3.

Constraints

N/A

Table 3 schemas field data structure description

Parameter

Mandatory

Type

Description

schema_name

Yes

String

Definition

Specifies the schema name.

Constraints

N/A

Range

The value contains 1 to 63 characters, including letters, digits, and underscores (_). It cannot start with pg or a digit, and must be different from RDS for PostgreSQL template database names and existing schema names.

RDS for PostgreSQL template databases include postgres, template0, and template1.

Existing schemas include public and information_schema.

Default Value

N/A

owner

Yes

String

Definition

Specifies the database owner.

Constraints

N/A

Range

The value contains 1 to 63 characters. 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.

Default Value

N/A

Example Request

Create a database schema.

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

{
    "db_name": "rds_test",
     "schemas": [
        {
            "schema_name": "teste123",
            "owner": "teste123"
        }
      ]
}

Response

  • Normal response
    Table 4 Parameters

    Parameter

    Type

    Description

    resp

    String

    Definition

    Calling result.

    Range

    Returns successful if the calling is successful.

Status Code

Error Code

For details, see Error Codes.