Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ DDM Instances/ Deleting a DDM Instance
Updated on 2024-08-02 GMT+08:00
View PDF
Share

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}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

To obtain this value, see Obtaining a 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

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

You can obtain the token by calling the IAM API used to obtain a user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

DDM instance ID

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

Example Request

  • Deleting a DDM instance (including the data stored on associated DB instances) 
    DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}?delete_rds_data=true
  • Deleting a DDM instance (excluding the data stored on 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.

Parent topic: DDM Instances