Help Center> Distributed Database Middleware> API Reference> APIs for Managing DDM Instances> Deleting a DDM Instance
View PDF

Deleting a DDM Instance

Function

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

URI

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

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Project ID of a tenant in a region

instance_id

Yes

DDM instance ID

delete_rds_data

No

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

  • If this parameter is not specified or set to true, the data stored in the associated RDS DB instances is deleted.
  • If this parameter is set to false, the data stored in the associated RDS DB instances is not deleted.

This parameter is set to true by default.

Request

Request parameters

None

Response

Response parameters

Parameter

Type

Mandatory

Description

id

String

true

DDM instance ID

Example

  • Example request

    None

  • Example response 
    {
    "id":"65c154c5-ffa7-4406-80c6-e13aca579b84"
}

For failure responses, see Abnormal Request Results.

Status Code

For details, see Status Codes.