Creating a Database (Discarded)¶

Function¶

This API is used to add a database.

Note

This API has been discarded and is not recommended.

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.

**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. Note A tag key can contain a maximum of 128 characters. Only letters, digits, spaces, and special characters `(_.:=+-@)` are allowed, but the value cannot start or end with a space or start with _sys_.
value	Yes	String	Tag key. Note A tag value can contain a maximum of 255 characters. Only letters, digits, spaces, and special characters `(_.:=+-@)` are allowed. The value cannot start or end with a space.

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¶

Create a test database named db1.

{
  "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 Codes.

last updated: 2024-12-10 15:25 UTC - commit: 9e0ebe18fe0b43010decd2c132af9f5362beb29e