批量修改消费组
功能介绍
批量修改消费组。
URI
PUT /v2/{project_id}/instances/{instance_id}/groups
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| instance_id | 是 | String | 参数解释: 实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| groups | 否 | Array of BatchUpdateConsumerGroup objects | 参数解释: 消费组列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 参数解释: 消费组名称。 约束限制: 只能由英文字母、数字、百分号、竖线、中划线、下划线组成,长度3~64个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
| broadcast | 否 | Boolean | 参数解释: 是否设置为广播消费。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| retry_max_time | 否 | Integer | 参数解释: 最大重试次数。 约束限制: 不涉及。 取值范围: 1~16。 默认取值: 不涉及。 |
| enabled | 否 | Boolean | 参数解释: 是否可以消费。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| consume_orderly | 否 | Boolean | 参数解释: 是否按顺序消费(仅RocketMQ实例5.x版本需要填写此参数)。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| group_desc | 否 | String | 参数解释: 消费组描述。 约束限制: 长度0~200个字符 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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 | 批量修改消费组成功。 |
错误码
请参见错误码。