更新消费组配置信息
更新时间 2026-07-07 10:18:54
最近更新时间: 2026-07-07 10:18:54
接口功能介绍
更新消费组配置信息
接口约束
无
URI
POST /v3/group/update
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码 | 200000002368 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例id | d7ed2dbad63843f4bcb3b9dc0955a617 | |
| groupName | 是 | String | 订阅组名称 | groupTest | |
| brokerNameList | 是 | Array of Strings | Broker名称列表 | ["broker_1"] | |
| consumeEnable | 是 | Boolean | 是否允许消费 | true | |
| consumeBroadcastEnable | 是 | Boolean | 是否允许广播消费 | false | |
| retryMaxTimes | 是 | Integer | 最大重试次数，取值范围[0,1000] | 16 | |
| remark | 否 | String | 备注 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 接口系统层面状态码。成功：800，失败：900。 | 800 | |
| message | String | 描述状态。 | ||
| returnObj | Object | 返回对象。 | ||
| error | String | 错误码，描述错误信息。 |
枚举参数
无
请求示例
请求url
https://[endpoint].ctapi.ctyun.cn/api/v3/group/update
请求头header
regionId: 200000002368
请求体body
{
"prodInstId": "d7ed2dbad63843f4bcb3b9dc0955a617",
"groupName": "groupTest",
"consumeEnable": true,
"consumeBroadcastEnable": false,
"retryMaxTimes": 16,
"remark": "更新消费组配置",
"brokerNameList": [
"broker_1"
]
}
响应示例
响应成功示例
{
"message": "success",
"returnObj": {},
"statusCode": 800
}
响应失败示例
{
"error": "ROCKETMQ_2002",
"message": "...",
"returnObj": {},
"statusCode": 900
}
状态码
请参考 状态码
错误码
请参考 错误码
