Updated on 2025-11-17 GMT+08:00

Deleting an Instance

Function

This API is used to delete a specified DCS instance to free up all resources occupied by the DCS instance.

To delete pay-per-use resources, perform operations in this section..

URI

DELETE /v2/{project_id}/instances/{instance_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

is_recycle

No

Boolean

Definition

Whether to move the deleted instance to the recycle bin.

Constraints

Redis 4.0 and later instances can be moved to the recycle bin.

Range

true: Yes

false: No, the deleted instance is directly destroyed.

Default Value

false

Response Parameters

Status code: 204

Instance deleted successfully.

None

Example Requests

  • Deleting a specified instance

    DELETE https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}
    
    {
      "is_recycle" : false
    }
  • Deleting specified instances and adding them to the recycle bin

    DELETE https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}
    
    {
      "is_recycle" : true
    }

Example Responses

None

Status Codes

Status Code

Description

204

Instance deleted successfully.

400

Invalid request.

500

Internal service error.

Error Codes

See Error Codes.