Updated on 2025-08-06 GMT+08:00

Deleting a Cluster

Function

This API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. For data security, you need to create a snapshot for a cluster before deleting it.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1.0/{project_id}/clusters/{cluster_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_id

Yes

String

Definition

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

keep_last_manual_snapshot

Yes

Integer

Definition

Number of snapshots to be retained in a cluster.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 202

The cluster is deleted successfully.

None

Example Requests

Delete a cluster.

DELETE https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90

{
  "keep_last_manual_snapshot" : 0
}

Example Responses

Status code: 202

The cluster is deleted successfully.

{ }

Status Codes

Status Code

Description

202

The cluster is deleted successfully.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.