Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ 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. Currently, instances billed on a yearly/monthly basis cannot be deleted. Before calling this API:

URI

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

Table 1 Parameter description

Name

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

Explanation:

Instance ID, which is the unique identifier of an instance.

Restrictions:

None

Value range:

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

Default value:

None

Request Parameters

None

Response Parameters

Table 2 Parameter description

Name

Type

Description

job_id

String

Explanation:

ID of the instance deletion task.

Value range:

UUID format

order_id

string

Explanation:

Order ID. This parameter is returned only when your instance is billed at a yearly/monthly basis. No information is returned when you unsubscribe from a yearly/monthly instance that has expired.

Value range:

None

Example Request

Deleting a DB instance

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

Example Response

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

Status Code

Error Code

For details, see Error Codes.

Parent topic: Instance Management