Deleting a DDM Instance¶

Function¶

This API is used to delete a DDM instance to release all its resources.

None

DELETE /v1/{project_id}/instances/{instance_id}

**Table 1** Path parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
instance_id	Yes	String	DDM instance ID

**Table 2** Query parameters¶
Parameter	Mandatory	Type	Description
delete_rds_data	No	String	Whether data stored on the associated DB instances is deleted. The value can be: true: indicates that the data stored on the associated DB instances is deleted. false: indicates that the data stored on the associated DB instances is not deleted. It is left blank by default. Enumerated values: true false

**Table 3** Request header 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.

Status code: 200

**Table 4** Response body parameters¶
Parameter	Type	Description
id	String	DDM instance ID
job_id	String	ID of the job for deleting an instance.

Status code: 400

**Table 5** Response body parameters¶
Parameter	Type	Description
errCode	String	Service error code
externalMessage	String	Error message

Status code: 500

**Table 6** Response body parameters¶
Parameter	Type	Description
errCode	String	Service error code
externalMessage	String	Error message

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
```

Status code: 200

{
  "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"
}

For details, see Error Codes.

last updated: 2024-12-11 13:43 UTC - commit: 0e04c4a111cf440cbe530f17da84f5c1ac074d8f