文档首页/ 分布式消息服务Kafka版/ API参考(巴黎区域)/ API V2（推荐）/ 生命周期管理/ 批量重启或删除实例
更新时间：2023-08-16 GMT+08:00
查看PDF
分享

批量重启或删除实例

功能介绍

批量重启或删除实例。

在实例重启过程中，客户端的生产与消费消息等请求会被拒绝。

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

URI

POST /v2/{project_id}/instances/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

instances

否

Array of strings

实例的ID列表。

action

是

String

对实例的操作：restart、delete

all_failure

否

String

参数值为kafka，表示删除租户所有创建失败的Kafka实例。

响应参数

状态码： 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" : "restart",
  "instances" : [ "54602a9d-5e22-4239-9123-77e350df4a34", "7166cdea-dbad-4d79-9610-7163e6f8b640" ]
}

  • 批量删除实例。

    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" : "kafka"
}

响应示例

状态码： 200

批量重启或删除实例成功。

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

状态码

状态码

描述

200

批量重启或删除实例成功。

错误码

请参见错误码。

父主题： 生命周期管理