This API is used to delete a DDM instance to release all its resources.
None
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:
|
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. |
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
DDM instance ID |
job_id |
String |
ID of the job for deleting an instance. |
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 |
DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}?delete_rds_data=true
DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}?delete_rds_data=false
Status code: 200
OK
{ "job_id" : "394976a1-8fb1-48b8-a2c0-a733405c1bb9", "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 Code |
Description |
---|---|
200 |
OK |
400 |
bad request |
500 |
server error |
For details, see Error Codes.