doc-exports/docs/opengauss/api-ref/opengauss_api_0017.html

Deleting a DB Instance

Function

This API is used to delete a DB instance. Before calling this API:

• Learn how to authenticate this API.
• Understand the API in Using APIs.
• Obtain the required region and endpoint.

URI

• URI format

  DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}

• Example

  https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
  instance_id	Yes	Instance ID.

Request

None

Response

• Normal response

  Table 2 Parameter description

  Name	Type	Description
  job_id	String	ID of the instance deletion task.

• Example normal response

  {
  	"job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  202

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management