Deleting a DDM Instance
Function
This API is used to delete a DDM instance to release all its resources.
Constraints
None
URI
DELETE /v1/{project_id}/instances/{instance_id}
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
project_id |
Yes |
String |
Project ID |
instance_id |
Yes |
String |
DDM instance ID |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
delete_rds_data |
No |
String |
Whether data stored on the associated DB instances is deleted. The value can be:
Enumerated values:
|
Request Parameters
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
X-Auth-Token |
Yes |
String |
User token It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
id |
String |
DDM instance ID |
Status code: 400
Parameter |
Type |
Description |
|---|---|---|
errCode |
String |
Service error code |
externalMessage |
String |
Error message |
Status code: 500
Parameter |
Type |
Description |
|---|---|---|
errCode |
String |
Service error code |
externalMessage |
String |
Error message |
Example Request
- Request to delete a DDM instance (including the data stored on the associated DB instances)
DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}?delete_rds_data=true - Request to delete a DDM instance (excluding the data stored on the associated DB instances)
DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}?delete_rds_data=false
Example Response
Status code: 200
OK
{
"id" : "9608ce63-bf66-4342-be8a-44f9b6b15d54"
}
Status code: 400
bad request
{
"externalMessage" : "Parameter error.",
"errCode" : "DBS.280001"
}
Status code: 500
server error
{
"externalMessage" : "Server failure.",
"errCode" : "DBS.200412"
}
Status Codes
Status Code |
Description |
|---|---|
200 |
OK |
400 |
bad request |
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.
