Creating a Database

Function

This API is used to add a database.

URI

URI format
POST /v1.0/{project_id}/databases

Parameter description

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

Request

**Table 2** Request parameters
Parameter	Mandatory	Type	Description
database_name	Yes	String	Name of the created database. The database name can contain only digits, letters, and underscores (_), but cannot contain only digits or start with an underscore (_). The database name is case insensitive and cannot be left blank. The length of the database name cannot exceed 128 characters. NOTE: The default database is a built-in database. You cannot create a database named default.
description	No	String	Information about the created database.
enterprise_project_id	No	String	Enterprise project ID. The value 0 indicates the default enterprise project. NOTE: Users who have enabled Enterprise Management can set this parameter to bind a specified project.
tags	No	Array of Objects	Database tag. For details, see Table 3.

**Table 3** tags parameters
Parameter	Mandatory	Type	Description
Key	Yes	String	Tag key.
value	Yes	String	Tag key.

Response

**Table 4** Response parameters
Parameter	Mandatory	Type	Description
is_success	No	Boolean	Whether the request is successfully executed. Value true indicates that the request is successfully executed.
message	No	String	System prompt. If execution succeeds, the parameter setting may be left blank.

Example Request

{
  "database_name": "db1",
  "description": "this is for test"
}

Example Response

{
 "is_success": true,
 "message": ""
}

Status Codes

Table 5 describes the status code.

**Table 5** Status codes
Status Code	Description
200	The job is created successfully.
400	Request error.
500	Internal service error.

Error Codes

If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.

Parent topic: Database-related APIs

Previous topic: Database-related APIs

Next topic: Deleting a Database