更新时间:2024-04-08 GMT+08:00

批量修改消费组

功能介绍

批量修改消费组。

URI

PUT /v2/{project_id}/instances/{instance_id}/groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

instance_id

String

实例ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

groups

Array of CreateOrUpdateConsumerGroup objects

消费组列表。

表3 CreateOrUpdateConsumerGroup

参数

是否必选

参数类型

描述

name

String

消费组名称,只能由英文字母、数字、百分号、竖线、中划线、下划线组成,长度3~64个字符。

brokers

Array of strings

关联的代理列表。

broadcast

Boolean

是否广播。

retry_max_time

Integer

最大重试次数,取值范围为1~16。

enabled

Boolean

是否可以消费。

consume_orderly

Boolean

是否按序消费。

group_desc

String

消费组描述,长度0~200个字符。

最小长度:0

最大长度:200

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

job_id

String

任务ID。

请求示例

批量修改消费组的参数,将consumer-group-test消费组的最大重试次数修改为16。

PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups

{
  "groups" : [ {
    "name" : "consumer-group-test",
    "enabled" : true,
    "broadcast" : false,
    "consume_orderly" : false,
    "retry_max_time" : 16
  } ]
}

响应示例

状态码: 200

批量修改消费组成功。

{
  "job_id" : "8abfa7b27da211df017da340427b0979"
}

状态码

状态码

描述

200

批量修改消费组成功。

错误码

请参见错误码