Help Center/ GaussDB/ API Reference/ Historical APIs/ DB Instance Management/ Deleting a DB Instance
Updated on 2024-08-20 GMT+08:00
View PDF
Share

Deleting a DB Instance

Function

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

This API will be unavailable on March 31, 2025. You are advised to switch workloads to the new API (Deleting a DB Instance) before then.

URI

DELETE https://{Endpoint}/opengauss/v3/{project_id}/instances/{instance_id}
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Explanation:

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Restrictions:

None

Value range:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

None

instance_id

Yes

Instance ID.

Request Parameters

None

Response Parameters

Table 2 Response parameters

Parameter

Type

Description

job_id

String

ID of the DB instance deletion task.

Example Request

https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01

Example Response

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

Status Code

Error Code

For details, see Error Codes.

Parent topic: DB Instance Management