Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Instance Management/ Deleting/Unsubscribing from a DB Instance
Updated on 2024-09-11 GMT+08:00
View PDF
Share

Deleting/Unsubscribing from a DB Instance

Function

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

URI

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

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

Instance ID, which is compliant with the UUID format.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token.

The value of X-Subject-Token in the response header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Values:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

job_id

String

Task ID.

order_id

String

Order ID. This parameter is returned only for yearly/monthly instances.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

  • Deleting a pay-per-use DB instance 
    DELETE https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07
  • Unsubscribe from a yearly/monthly DB instance 
    DELETE https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07

Example Response

Status code: 200

Success.

  • Pay-per-use DB instance 
    {
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}
  • Yearly/monthly DB instance 
    {
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890",
  "order_id" : "CS2305230939BMXV8"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management