GET https://[endpoint].ctapi.ctyun.cn/v2/group/list
请求参数
请求参数 | 是否必填 | 位置 | 参数类型 | 说明 |
prodInstId | 是 | url | String | 实例ID |
响应参数
响应参数 | 参数类型 | 描述 |
statusCode | String | 接口系统层面状态码。成功：800，失败：900 |
message | String | 描述状态 |
returnObj | String | 返回对象。此参数所包含的参数请见“响应示例"里面的注释 |
返回值returnObj参数说明
响应参数 | 参数类型 | 描述 |
total | Integer | 总数 |
rows | List | 订阅组列表 |
返回值rows参数说明
响应参数 | 参数类型 | 描述 |
groupName | Integer | 总数 |
consumeEnable | List | 订阅组列表 |
consumeFromMinEnable | Boolean | 是否从最小偏移量消费 |
consumeBroadcastEnable | Boolean | 是否启用广播消费 |
retryQueueNums | Integer | 重试队列数 |
retryMaxTimes | Integer | 重试消费次数 |
brokerId | Long | BrokerId |
whichBrokerWhenConsumeSlowly | Long | 消费慢切换broker消费 |
notifyConsumerIdsChangedEnable | Boolean | 是否通知消费实例变化 |
pullMechanism | Integer | 消费机制 |
firstConsumeMechanism | Integer | 首次消费机制 |
subscribeMap | HashMap<String, SubscribeLimit> | SubscribeLimit：tpsThreshold 订阅组对应主题tps阈值 |
brokerName | String | Broker名称 |
请求示例
GET https://[endpoint].ctapi.ctyun.cn/v2/group/list?prodInstId=70687660456281088
响应成功示例
{
"returnObj":{
"total":1,
" rows ":[
{
"groupName":"group",
"consumeEnable":true,
"consumeFromMinEnable":false,
"consumeBroadcastEnable":false,
"retryQueueNums":1,
"retryMaxTimes":16,
"brokerId":0,
"whichBrokerWhenConsumeSlowly":1,
"notifyConsumerIdsChangedEnable":true,
"pullMechanism":1,
"firstConsumeMechanism":1,
"subscribeMap":{
},
"brokerName":"mq_test_broker_1"
}
]
},
"message":"success",
"statusCode":800
}
响应失败示例
{
"returnObj": {},
"message": "...",
"statusCode": "900"
}