Files

Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>

2026-03-03 12:01:43 +00:00

18 KiB

Raw Blame History

Deleting a DDM Instance (a V1 API)

Function

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

Constraints

This API is to be removed soon, so it is not recommended.
Use the latest API. For details, see Deleting an Instance (a V3 API).

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	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 It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

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

Example Request

Request to delete a DDM instance (including the data stored on the associated DB instances)

DELETE https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09?delete_rds_data=true

Request to delete a DDM instance (excluding the data stored on the associated DB instances)

DELETE https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09?delete_rds_data=false

Example Response

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

Status Codes

Status Code	Description
200	OK
400	bad request
500	server error

Error Codes

For details, see Error Codes.

Parent topic: Instance Management

18 KiB Raw Blame History