查询订阅组列表
更新时间 2025-11-27 16:34:19
最近更新时间: 2025-11-27 16:34:19
接口功能介绍
查询订阅组列表
接口约束
无
URI
GET /v3/group/list
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例ID |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码 | 200000002368 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 接口系统层面状态码。成功：800，失败：900 | ||
| message | String | 描述状态 | ||
| returnObj | Object | 返回对象 | returnObj | |
| error | String | 错误码，只有非成功才有这个字段，方便快速定位问题 | 201 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| rows | Array of Objects | 消费组信息列表 | rows | |
| total | Integer | 总记录数。 | 1 | |
| 表 rows |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| groupName | String | 消费组名称 | Group0317 | |
| consumeEnable | Boolean | 是否允许消费 | true | |
| consumeFromMinEnable | Boolean | 是否从最小位点消费 | true | |
| consumeBroadcastEnable | Boolean | 是否允许广播消费 | false | |
| retryQueueNums | Integer | 重试队列数量 | 1 | |
| retryMaxTimes | Integer | 最大重试次数 | 16 | |
| brokerId | Integer | Broker ID | 0 | |
| whichBrokerWhenConsumeSlowly | Integer | 消费慢时指定的Broker ID | 1 | |
| notifyConsumerIdsChangedEnable | Boolean | 是否开启消费者ID变更通知 | true | |
| pullMechanism | Integer | 拉取机制 | 1 | |
| firstConsumeMechanism | Integer | 首次消费机制 | 1 | |
| subscribeMap | Object | 订阅关系 | ||
| remark | String | 备注 | ||
| brokerName | String | Broker名称 | broker_1 | |
| type | Integer | 类型 | 0 | |
| allowdAllTopics | Boolean | 是否允许所有主题 | false |
枚举参数
无
请求示例
请求url
https://[endpoint].ctapi.ctyun.cn/v3/group/list?prodInstId=70687660456281088
请求头header
无
请求体body
无
响应示例
响应成功示例
{
"message": "success",
"returnObj": {
"rows": [{
"groupName": "Group0317",
"consumeEnable": true,
"consumeFromMinEnable": true,
"consumeBroadcastEnable": false,
"retryQueueNums": 1,
"retryMaxTimes": 16,
"brokerId": 0,
"whichBrokerWhenConsumeSlowly": 1,
"notifyConsumerIdsChangedEnable": true,
"pullMechanism": 1,
"firstConsumeMechanism": 1,
"subscribeMap": {},
"remark": null,
"namesrvAddr": null,
"clusterName": null,
"brokerName": "broker_1",
"type": 0,
"allowdAllTopics": false
}],
"total": 1
},
"statusCode": 800
}
响应失败示例
{
"returnObj": {},
"message": "...",
"error":"201",
"statusCode": "900"
}
状态码
请参考 状态码
错误码
请参考 错误码
