Creating a Database
Function
This API is used to create a database for a GaussDB(for MySQL) instance. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
URI
POST /v3/{project_id}/instances/{instance_id}/databases
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. |
instance_id |
Yes |
String |
Instance ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. If the following response body is returned for calling the API used to obtain a user token, the request is successful. After the request is processed, the value of X-Subject-Token in the message header is the token value. |
X-Language |
No |
String |
Request language type. The default value is en-us. Value:
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
databases |
Yes |
Array of CreateGaussMySqlDatabase objects |
Database information list. The list contains up to 50 databases. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Database name. The name can contain 1 to 64 characters. Only letters, digits, and underscores (_) are allowed. |
comment |
No |
String |
Database remarks. The value can consist of up to 512 characters, and cannot contain the carriage return characters or special characters (!<"='>&). |
character_set |
Yes |
String |
Database character set, for example, utf8mb4 or gbk. |
users |
No |
Array of GaussMySqlDatabaseUser objects |
List of database users. The list contains up to 50 database users. When you create a database, you can authorize the database permissions to the users in the list. If there is no database user in the list, you cannot authorize the database permissions to database users when creating a database. If you need to authorize the database permissions to a database user later, call the API (Authorizing Permissions to a Database User). |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
ID of the task for creating a database. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
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)
{ "databases" : [ { "name" : "test", "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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.