更新时间:2026-04-03 GMT+08:00

批量删除实例

功能介绍

批量删除实例。实例删除后,实例中原有的数据将被删除,且没有备份,请谨慎操作。

URI

POST /v2/{project_id}/instances/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,获取方式请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

instances

否

Array of strings

参数解释:

实例的ID列表。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

action

是

String

参数解释:

对实例的操作:delete。

约束限制:

不涉及。

取值范围:

  • delete

默认取值:

不涉及

all_failure

否

String

参数解释:

参数值为reliability,表示删除租户所有创建失败的RocketMQ实例。

约束限制:

不涉及。

取值范围:

  • reliability

默认取值:

不涉及。

force_delete

否

Boolean

参数解释:

是否强删除。

约束限制:

不涉及。

取值范围:

  • true:强删除,强删除实例不进入回收站。

  • false:弱删除,开启回收站功能后,实例进入回收站。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

results

Array of results objects

参数解释:

修改实例的结果。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表4 results

参数

参数类型

描述

result

String

参数解释:

操作结果。

约束限制:

不涉及。

取值范围:

  • success

  • failed

默认取值:

不涉及。

instance

String

实例ID。

状态码:204

批量删除创建失败的RocketMQ实例成功。

请求示例

  • 批量删除RocketMQ实例。

    POST https://{endpoint}/v2/{project_id}/instances/action
    
    {
      "action" : "delete",
      "instances" : [ "54602a9d-5e22-4239-9123-77e350df4a34", "7166cdea-dbad-4d79-9610-7163e6f8b640" ]
    }
  • 删除所有创建失败的RocketMQ实例。

    POST https://{endpoint}/v2/{project_id}/instances/action
    
    {
      "action" : "delete",
      "all_failure" : "reliability"
    }

响应示例

状态码:200

批量删除实例成功。

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

状态码

状态码

描述

200

批量删除实例成功。

204

批量删除创建失败的RocketMQ实例成功。

错误码

请参见错误码。