Updated on 2025-09-10 GMT+08:00

Adding an RDS Database

Function

Adding an RDS Database

URI

POST /v3/{project_id}/audit/{instance_id}/databases/rds

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. (The token is the value of X-Subject-Token in the response header.)

** Restrictions**:

N/A

Range:

Used by the IAM service to query the user token.

** Default value**:

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

databases

Yes

Array of databases objects

Databases

Table 4 databases

Parameter

Mandatory

Type

Description

id

Yes

String

RDS database ID, which can be obtained from the ID field of the API for querying the RDS database list.

type

Yes

String

Applicable Database

  • MYSQL

  • ORACLE

  • POSTGRESQL

  • SQLSERVER

  • DAMENG

  • TAURUS

  • DWS

  • KINGBASE

  • MARIADB

  • GAUSSDBOPENGAUSS

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

ret_list

Array of ret_list objects

Result list

Table 6 ret_list

Parameter

Type

Description

id

String

RDS database ID

ret_status

String

Alarm status.

  • SUCCESS

  • FAILED

ret_message

String

Description

Status code: 400

Table 7 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 8 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 403

Table 9 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 10 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 500

Table 11 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 12 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Example Requests

/v3/{project_id}/audit/{instance_id}/databases/rds

{
  "databases" : [ {
    "id" : "123751d3ee2f47aea64822e98318c6a8in01",
    "type" : "MYSQL"
  } ]
}

Example Responses

Status code: 200

Success

{
  "ret_list" : [ {
    "id" : "123751d3ee2f47aea64822e98318c6a8in01",
    "ret_status" : "SUCCESS",
    "ret_message" : null
  }, {
    "id" : "2343f7285d684fed8b09fac201c3fc7ain01",
    "ret_status" : "FAILED",
    "ret_message" : "Unknown error."
  } ]
}

Status Codes

Status Code

Description

200

Success

400

Failed

403

Authorization failed.

500

Server error.

Error Codes

See Error Codes.