查询订阅组当前客户端的连接情况
更新时间 2025-11-27 16:34:27
最近更新时间: 2025-11-27 16:34:27
接口功能介绍
查询订阅组当前客户端的连接情况
接口约束
无
URI
GET /v3/consumer/connection
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例ID | ||
| groupName | 是 | String | 订阅组名字 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码 | 200000002368 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 接口系统层面状态码。成功：800，失败：900 | 800 | |
| message | String | 描述状态 | ||
| returnObj | Object | 返回对象 | returnObj | |
| error | String | 错误码，只有非成功才有这个字段，方便快速定位问题 | ||
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| data | Object | 响应数据详情 | data | |
| 表 data |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| group | Object | 消费组详情 | group | |
| 表 group |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| connectionSet | Array of Objects | 客户端连接集合 | connectionSet | |
| subscriptionTable | Object | 订阅关系表 | subscriptionTable | |
| consumeType | String | 消费类型 | CONSUME_PASSIVELY | |
| messageModel | String | 消费方式 CLUSTERING-集群消费;BROADCASTING-广播消费 | CLUSTERING | |
| consumeFromWhere | String | 消费起始位置 | CONSUME_FROM_FIRST_OFFSET | |
| 表 connectionSet |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| clientId | String | 客户端ID | 5.5.148.141@test_instance | |
| clientAddr | String | 客户端地址 | 192.168.71.1:52369 | |
| language | String | 客户端开发语言 | JAVA | |
| version | Integer | 客户端版本 | 297 | |
| 表 subscriptionTable |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| classFilterMode | Boolean | 类过滤模式开关 | false | |
| topic | String | 订阅主题 | test | |
| subString | String | 订阅表达式 | * | |
| tagsSet | Array of Strings | 标签集合 | [] | |
| codeSet | Array of Strings | 代码集合 | [] | |
| subVersion | Long | 订阅版本号 | 1661916951326 | |
| expressionType | String | 表达式类型 | null | |
| filterClassSource | String | 过滤类源码 | null |
枚举参数
无
请求示例
请求url
https://[endpoint].ctapi.ctyun.cn/v3/consumer/connection?prodInstId=70687660456281088&groupName=group
请求头header
无
请求体body
无
响应示例
响应成功示例
{
"returnObj":{
"data":{
"group":{
"connectionSet":[
{
"clientId":"5.5.148.141@test_instance",
"clientAddr":"192.168.71.1:52369",
"language":"JAVA",
"version":297
}
],
"subscriptionTable":{
"%RETRY%group":{
"classFilterMode":false,
"topic":"%RETRY%group",
"subString":"*",
"tagsSet":[
],
"codeSet":[
],
"subVersion":1661916951262,
"expressionType":null,
"filterClassSource":null
},
"test":{
"classFilterMode":false,
"topic":"test",
"subString":"*",
"tagsSet":[
],
"codeSet":[
],
"subVersion":1661916951326,
"expressionType":null,
"filterClassSource":null
}
},
"consumeType":"CONSUME_PASSIVELY",
"messageModel":"CLUSTERING",
"consumeFromWhere":"CONSUME_FROM_FIRST_OFFSET"
}
}
},
"message":"success",
"statusCode":800
}
响应失败示例
{
"returnObj": {},
"message": "...",
"error":"201",
"statusCode": "900"
}
状态码
请参考 状态码
错误码
请参考 错误码
