Help Center/ Database Security Service/ API Reference/ API Description/ APIs to Be Taken Offline/ Adding an RDS Database (To Be Brought Offline)
Updated on 2026-01-22 GMT+08:00
View PDF
Share

Adding an RDS Database (To Be Brought Offline)

Function

Add an RDS database. V1 is no longer maintained and will be brought offline.

URI

POST /v1/{project_id}/{instance_id}/dbss/audit/databases/rds

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Specifies the project ID. You can obtain the value by calling the IAM API for querying the project list of a specified IAM user.

Constraints

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.

Constraints

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

databases

Yes

Array of databases objects

List of added databases

total_count

No

Integer

Total number of license files
Table 4 databases

Parameter

Mandatory

Type

Description

id

Yes

String

The database record ID.

db_name

Yes

String

Database name

status

Yes

String

Database status.

  • ON: enabled

  • OFF: disabled

port

Yes

String

Database Port

ip

Yes

String

Database IP address

instance_name

Yes

String

Database instance name

version

Yes

String

DB Version

type

Yes

String

Database type.

  • MYSQL: MySQL

  • ORACLE: Oracle

  • POSTGRESQL: PostgreSQL

  • TAURUS: TaurusDB

  • DWS

  • GAUSSDBOPENGAUSS: GaussDB/openGauss

  • DDS: DDS(MongoDB)

enterprise_id

Yes

String

Enterprise project ID

enterprise_name

No

String

Specifies the enterprise project name.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

illegal_db_id

Array of strings

ID of the database instance that fails to be added

legal_db_id

Array of strings

ID of the database instance that is successfully added

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

/v1/{project_id}/{instance_id}/dbss/audit/databases/rds

{
  "databases" : [ {
    "id" : "123751d3ee2f47aea64822e98318c6a8in01",
    "db_name" : "rds1",
    "status" : "ACTIVE",
    "port" : "3306",
    "ip" : "192.168.0.119",
    "instance_name" : "rds1",
    "version" : "8.0",
    "type" : "MySQL",
    "enterprise_id" : "0",
    "enterprise_name" : "default"
  }, {
    "id" : "2343f7285d684fed8b09fac201c3fc7ain01",
    "db_name" : "rds2",
    "status" : "ACTIVE",
    "port" : "3306",
    "ip" : "192.168.0.92",
    "instance_name" : "rds2",
    "version" : "8.0",
    "type" : "MySQL",
    "enterprise_id" : "0",
    "enterprise_name" : "default"
  } ]
}

Example Responses

Status code: 200

Success

{
  "illegal_db_id" : [ ],
  "legal_db_id" : [ "123751d3ee2f47aea64822e98318c6a8in01", "2343f7285d684fed8b09fac201c3fc7ain01" ]
}

Status Codes

Status Code

Description

200

Success

400

Failed

403

Authorization failed.

500

Server error.

Error Codes

See Error Codes.

Parent topic: APIs to Be Taken Offline