Creating a Database Schema

Function

This API is used to create a database schema in a specified instance. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

Constraints

This operation cannot be performed when the instance is in any of the following statuses: creating, changing instance specifications, frozen, or abnormal.

Debugging

You can debug this API in API Explorer.

URI

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

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. For details about how to obtain the instance ID, see Querying DB Instances. Constraints N/A Range The value can contain 36 characters. 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. You can obtain the token by calling the IAM API used to obtain a user token. After a response is returned, the value of X-Subject-Token in the response header is the token. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Language. Constraints N/A Range zh-cn: Chinese en-us: English Default Value en-us

**Table 3** Parameter description
Parameter	Mandatory	Type	Description
db_name	Yes	String	Definition Database name. Constraints The name cannot be a template database and must be an existing database name. Template databases include postgres, template0, template1. Range The value can contain 1 to 63 characters, including letters, digits, and underscores (_). Default Value N/A
schemas	Yes	Array of objects	Definition Schemas. Each element is the schema information associated with the database. For details, see Table 4. Constraints A single request supports a maximum of 20 elements.

**Table 4** schemas field data structure description
Parameter	Mandatory	Type	Description
name	Yes	String	Definition Schema name. Constraints The name cannot contain other special characters, cannot start with pg or a digit, and cannot be the same as the name of a template database or an existing schema. Template databases include postgres, template0, template1. Existing schemas include public and information_schema. Range A schema name can contain 1 to 63 characters, including letters, digits, and underscores (_). Default Value N/A
owner	Yes	String	Definition Database owner. Constraints The value cannot be a system user. It must be an existing database username. System users: rdsAdmin, rdsMetric, rdsBackup, and rdsRepl. Range The value can contain 1 to 63 characters, including letters, digits, and underscores (_). Default Value N/A

Response Parameters

None

Example Request

Creating multiple schemas in the gaussdb_test database

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/{instance_id}/schema
{ 
   "db_name" : "gaussdb_test", 
   "schemas" : [ { 
     "name" : "rds", 
     "owner" : "teste123" 
   }, { 
     "name" : "rds001", 
     "owner" : "teste123" 
   } ] 
 }