修改消费组
功能介绍
修改指定消费组参数。
URI
PUT /v2/{project_id}/instances/{instance_id}/groups/{group}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| instance_id | 是 | String | 参数解释: 实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| group | 是 | String | 参数解释: 消费组名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| enabled | 是 | Boolean | 参数解释: 是否可以消费。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| broadcast | 是 | Boolean | 参数解释: 是否设置为广播消费。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| brokers | 否 | Array of strings | 参数解释: 关联的代理列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| name | 否 | String | 参数解释: 待修改参数的消费组(消费组名称不支持修改)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| retry_max_time | 是 | Integer | 参数解释: 最大重试次数。 约束限制: 不涉及。 取值范围: 1~16。 默认取值: 不涉及。 |
| consume_orderly | 否 | Boolean | 参数解释: 是否按顺序消费。 约束限制: 仅RocketMQ实例5.x版本需要填写此参数。 取值范围: 默认取值: 不涉及。 |
| group_desc | 否 | String | 参数解释: 消费组描述。 约束限制: 不涉及。 取值范围: 0~200。 默认取值: 不涉及。 |
响应参数
状态码:204
修改指定消费组参数成功。
无
请求示例
修改consumer-group-test消费组的参数,最大重试次数修改为16。
PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/{group}
{
"enabled" : true,
"retry_max_time" : 16,
"broadcast" : true
} 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 204 | 修改指定消费组参数成功。 |
错误码
请参见错误码。