Updated on 2026-10-21 GMT+08:00

Deleting a DWS Cluster

Function

This v2 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 /v2/{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

The value must be a valid DWS cluster ID.

Range

It is a 36-digit UUID.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

keep_last_manual_backup

No

String

Definition

Number of snapshots to be retained in a cluster.

Constraints

N/A

Range

N/A

Default Value

0

release_eip_type

No

String

Definition:

Whether to release the EIP bound to the cluster. The default value is NO_RELEASE, indicating that the EIP is not released.

Constraints:

None

Range:

  • NO_RELEASE: Do not release the bound EIP.

  • RELEASE_BINDING: Release the bound EIP.

Default Value:

NO_RELEASE

Request Parameters

None

Response Parameters

Status code: 202

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error message.

Range

N/A

job_id

String

Definition

Task ID, which can be used to query the task progress.

Range

null indicates that the asynchronous task information is not returned. Other values indicate the asynchronous task IDs.

Example Requests

Delete a cluster.

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

Example Responses

Status code: 202

{
  "job_id" : "g6aa82ba1fc9748389b613e8da13e2fe9"
}

Status Codes

Status Code

Description

202

Cluster deleted.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.