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

Kafka实例批量删除Group

功能介绍

该接口用于向Kafka实例批量删除Group。

URI

POST /v2/{project_id}/instances/{instance_id}/groups/batch-delete

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

group_ids

否

Array of strings

所有需要删除的消费组ID。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

failed_groups

Array of failed_groups objects

删除失败的消费组列表。

total

Integer

删除失败的个数
表4 failed_groups

参数

参数类型

描述

group_id

String

删除失败的消费组ID。

error_message

String

删除失败的原因。

请求示例

批量删除消费组。

POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/batch-delete

{
  "group_ids" : [ "get-sync-group0", "get-sync-group1" ]
}

响应示例

状态码： 200

删除消费组成功。

{
  "failed_groups" : [ {
    "group_id" : "test-1",
    "error_message" : "UNKNOW"
  }, {
    "group_id" : "test-2",
    "error_message" : "UNKNOW"
  } ],
  "total" : 2
}

状态码

状态码

描述

200

删除消费组成功。

错误码

请参见错误码。

父主题： 实例管理