Adding a Self-Built Database

Function

URI

POST /v2/{project_id}/audit/{instance_id}/databases

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID You can obtain the value by calling the IAM API for querying the project list of a specified IAM user. Restrictions: N/A Range: The value is subject to the return value of the IAM service interface. The value contains 32 to 64 characters. Default value: N/A
instance_id	Yes	String	Definition: Instance ID. The value can be obtained from the ID field of the API for querying the instance list. Restrictions: N/A Range: The value is subject to the value of the API for querying the instance list. The value contains 32 to 64 characters. Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. The token can be queried by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Constraints: N/A Value range: You can obtain the value by calling the IAM API used to query a user token. Default value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
database	Yes	database object	Database information

**Table 4** database
Parameter	Mandatory	Type	Description
db_classification	Yes	String	Database classification. The value can be: RDS ECS: self-built database
name	Yes	String	Database name
type	Yes	String	Database type. MYSQL: MySQL ORACLE: Oracle POSTGRESQL: PostgreSQL SQLSERVER: SQL Server DAMENG TAURUS: TaurusDB DWS KINGBASE: Kingbase GAUSSDBOPENGAUSS: GaussDB/openGauss GREENPLUM: Greenplum HIGHGO: HIGHGO SHENTONG: ShenTong GBASE8A: GBase 8a GBASE8S: GBase 8s GBASEXDM: GBase XDM MONGODB: MongoDB DDS: DDS(MongoDB)
version	Yes	String	DB Version
charset	Yes	String	Character set. GBK UTF8
ip	Yes	String	Database IP address
port	Yes	String	Database Port
os	Yes	String	Database OS. LINUX64 WINDOWS64 UNIX
instance_name	No	String	Database instance name

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
id	String	The database record ID.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error Codes
error_msg	String	Error message.

**Table 7** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error Codes
error_msg	String	Error message.

**Table 9** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error Codes
error_msg	String	Error message.

**Table 11** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Example Requests

/v2/{project_id}/audit/{instance_id}/databases

{
  "database" : {
    "name" : "test",
    "type" : "POSTGRESQL",
    "version" : "7.4",
    "charset" : "UTF8",
    "ip" : "1.1.1.1",
    "port" : "66",
    "instance_name" : "testaaa",
    "os" : "LINUX64",
    "db_classification" : "ECS"
  }
}