Creating a Database Schema
Function
This API is used to create a database schema in 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, or abnormal.
URI
- Parameter description
Table 1 Parameter description Name
Mandatory
Description
project_id
Yes
Specifies the 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
Name |
Mandatory |
Type |
Description |
---|---|---|---|
db_name |
Yes |
String |
Specifies the database name. 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 library names. RDS for PostgreSQL template libraries include postgres, template0, and template1. |
schemas |
Yes |
Array of objects |
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. |
Name |
Mandatory |
Type |
Description |
---|---|---|---|
schema_name |
Yes |
String |
Specifies the schema name. 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 library names and existing schema names. RDS for PostgreSQL template libraries include postgres, template0, and template1. Existing schemas include public and information_schema. |
owner |
Yes |
String |
Specifies the database owner. 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. |
Example Request
Creating a database schema
{ "db_name": "rds_test", "schemas": [ { "schema_name": "teste123", "owner": "teste123" } ] }
Response
- Normal response
Table 4 Parameter description Name
Type
Description
resp
String
Returns successful if the invoking is successful.
- Example normal response
{ "resp": "successful" }
- Abnormal response
For details, see Abnormal Request Results.
Status Code
- Normal
- Abnormal
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.