Batch Deleting Instances

Updated on 2022-09-14 GMT+08:00

View PDF

Function

This API is used to delete instances in batches. Data in the instance will be deleted without any backup. Exercise caution when performing this operation.

URI

POST /v2/{project_id}/instances/action

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
instances	No	Array of strings	List of instance IDs.
action	Yes	String	Operation to be performed on instances. Value: delete.
all_failure	No	String	When set to RocketMQ, this parameter indicates all RocketMQ instances that fail to be created are to be deleted.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
results	Array of results objects	Result of instance modification.

**Table 4** results
Parameter	Type	Description
result	String	Operation result.
instance	String	Instance ID.

Example Requests

Deleting instances in batches

POST https://{endpoint}/v2/{project_id}/instances/action

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

Deleting all instances that fail to be created

POST https://{endpoint}/v2/{project_id}/instances/action

{
  "action" : "delete",
  "allFailure" : "rocketmq"
}

Example Responses

Status code: 200

Instances deleted.

{
  "results" : [ {
    "result" : "success",
    "instance" : "019cacb7-4ff0-4d3c-9f33-f5f7b7fdc0e6"
  } ]
}

Status Codes

Status Code	Description
200	Instances deleted.

Error Codes

See Error Codes.

Parent topic: Lifecycle Management

Previous topic: Modifying Instance Information

Next topic: Querying the Broker List

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel