更新时间:2024-10-29 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

all_failure

String

是否批量删除创建失败的实例。

当参数值为“rabbitmq”时,删除租户所有创建失败的实例,此时请求参数instances可为空。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

results

Array of results objects

修改实例的结果。

表4 results

参数

参数类型

描述

result

String

操作结果:

  • success: 操作成功

  • failed: 操作失败

instance

String

实例ID。

请求示例

  • 批量删除实例。

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

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

响应示例

状态码: 200

批量删除实例成功。

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

状态码

状态码

描述

200

批量删除实例成功。

204

删除所有创建失败的RabbitMQ实例成功。

错误码

请参见错误码