Deleting an Instance (a V3 API)

Function

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

Constraints

Yearly/Monthly instances cannot be deleted.

URI

• URL format

  DELETE /v3/{project_id}/instances/{instance_id}

• Parameter description

  Table 1 URI 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_dn_data	No	Boolean	Whether data stored on the associated DB instances is deleted. This parameter is left empty by default. true: indicates that the data stored on the associated DB instances is deleted. false or leaving this parameter empty: indicates that the data stored on the associated DB instances is not deleted.

Request

Example Request

DELETE https://{endpoint}/v3/{project_id}/instances/{instance_id}?delete_dn_data=true

DELETE https://{endpoint}/v3/{project_id}/instances/{instance_id}?delete_dn_data=false

Response

• Normal response

  Table 4 Response body parameters

  Parameter	Type	Description
  job_id	String	ID of the job for deleting an instance.

• Normal response example

  {
   "job_id": "eff1d289-xxxx-xxxx-8b9f-463ea07c000c"
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Codes

• Normal

  202

• Abnormal

  For details, see Status Codes.

Error Codes

For details, see Error Codes.