Adding an RDS Database
Function
This API is used to add an RDS database.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/{instance_id}/audit/databases/rds
Parameter |
Mandatory |
Parameter Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
instance_id |
Yes |
String |
Instance ID. You can obtain the value from the ID field in the API for querying the instance list. |
Request Parameter
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
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.) |
Parameter |
Mandatory |
Parameter Type |
Description |
---|---|---|---|
databases |
Yes |
Array of databases objects |
Database list |
Response Parameters
Status code: 200
Parameter |
Parameter Type |
Description |
---|---|---|
ret_list |
Array of ret_list objects |
Result list. |
Parameter |
Parameter Type |
Description |
---|---|---|
id |
String |
RDS database ID |
ret_status |
String |
Status
|
ret_message |
String |
Description |
Status code: 400
Parameter |
Parameter Type |
Description |
---|---|---|
error |
Object |
Error message. |
Parameter |
Parameter Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
Status code: 403
Parameter |
Parameter Type |
Description |
---|---|---|
error |
Object |
Error message. |
Parameter |
Parameter Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
Status code: 500
Parameter |
Parameter Type |
Description |
---|---|---|
error |
Object |
Error message. |
Parameter |
Parameter Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
Example Request
/v2/{project_id}/{instance_id}/audit/databases/rds
{
"databases" : [ {
"id" : "123751d3ee2f47aea64822e98318c6a8in01",
"type" : "MYSQL"
} ]
}
Example Responses
Status code: 200
Succeeded
{
"ret_list" : [ {
"id" : "123751d3ee2f47aea64822e98318c6a8in01",
"ret_status" : "SUCCESS",
"ret_message" : null
}, {
"id" : "2343f7285d684fed8b09fac201c3fc7ain01",
"ret_status" : "FAILED",
"ret_message" : "Unknown error."
} ]
}
Status code: 400
Failed
{
"error" : {
"error_code" : "DBSS.XXXX",
"error_msg" : "XXX"
}
}
Status Code
Status Code |
Description |
---|---|
200 |
Success |
400 |
Failed |
403 |
Authentication failed. |
500 |
Server error. |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.