更新时间:2023-08-16 GMT+08:00

修改消费组

功能介绍

修改指定消费组参数。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

instance_id

String

实例ID。

group

String

消费组名称。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

enabled

Boolean

是否可以消费。

broadcast

Boolean

是否广播。

brokers

Array of strings

关联的代理列表。

name

String

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

retry_max_time

Number

最大重试次数。

from_beginning

Boolean

是否重头消费。

响应参数

请求示例

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

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

{
  "name" : "consumer-group-test",
  "enabled" : true,
  "retry_max_time" : 16,
  "from_beginning" : true,
  "broadcast" : true
}

响应示例

状态码

状态码

描述

204

操作成功。

错误码

请参见错误码