Help Center/ Distributed Database Middleware/ API Reference (Kuala Lumpur Region)/ DDM Instance Management/ Deleting a DDM Instance
Updated on 2022-08-17 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

instance_id

Yes

String

DDM instance ID
Table 2 Query parameters

Parameter

Mandatory

Type

Description

delete_rds_data

No

Boolean

Whether to delete the data stored on the associated RDS DB instances.

  • true: indicates that the data stored on the associated RDS DB instances is deleted.
  • false: indicates that the data stored on the associated RDS DB instances is not deleted.

This parameter is left blank by default.

NOTE:

Parameter values are case-insensitive.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

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

DELETE https://{endpoint}/v1/{project_id}/instances/{instance_id}?delete_rds_data=true

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" : "Parameter error.",
  "errCode" : "DBS.280001"
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: DDM Instance Management