Creating a Database
Function
This API is used to create a database for a TaurusDB 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 |
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 can contain 36 characters with a suffix of in07. Only letters and digits are allowed. Default value: N/A |
Request 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: Default value: en-us |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
databases |
Yes |
Array of CreateGaussMySqlDatabase objects |
Definition: Database list. Constraints: The list can contain a maximum of 50 databases. |
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, and underscores (_) are allowed. 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:
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. |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
Definition: ID of the task for creating a database. Range: N/A |
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.