Help Center/ Distributed Cache Service/ API Reference/ API V2/ Lifecycle Management/ Batch Deleting DCS Instances
Updated on 2025-05-13 GMT+08:00
View PDF

Batch Deleting DCS Instances

Function

This API is used to delete multiple DCS instances at a time.

Calling Method

For details, see Calling APIs.

URI

DELETE /v2/{project_id}/instances

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

all_failure

No

Boolean

Whether to delete all DCS instances that failed to be created. Values:

  • true: all instances that fail to be created are deleted. In this case, the instances parameter in the request can be empty.

  • false or other values: The DCS instances specified by the instances parameter will be deleted.

Request Parameters

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

instances

No

Array of strings

List of instance IDs.

This parameter is set only when the all_failure parameter in the URI is set to false or another value.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

results

Array of BatchOpsResult objects

Result of deleting, restarting, or clearing data of an instance.
Table 5 BatchOpsResult

Parameter

Type

Description

result

String

Instance deletion result. Options: success and failed.

instance

String

DCS instance ID.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Example Requests

Batch deleting DCS instances

DELETE https://{dcs_endpoint}/v2/{project_id}/instances?all_failure={all_failure}

{
  "instances" : [ "54602a9d-5e22-4239-9123-77e350df4a34", "7166cdea-dbad-4d79-9610-7163e6f8b640" ]
}

Example Responses

Status code: 200

DCS instances deleted successfully.

{
  "results" : [ {
    "result" : "success",
    "instance" : "54602a9d-5e22-4239-9123-77e350df4a34"
  }, {
    "result" : "success",
    "instance" : "7166cdea-dbad-4d79-9610-7163e6f8b640"
  } ]
}

Status Codes

Status Code

Description

200

DCS instances deleted successfully.

400

Invalid request.

500

Internal service error.

Error Codes

See Error Codes.

Parent topic: Lifecycle Management