分布式消息服务-RocketMQ

查询订阅组当前客户端的连接情况

2024-07-02 09:03:52

GET https://[endpoint].ctapi.ctyun.cn/v2/consumer/connection

请求参数

请求参数

是否必填

位置

参数类型

说明

prodInstId

url

String

实例ID

groupName

url

String

订阅组名字

响应参数

参数类型

描述

statusCode

String

接口系统层面状态码。成功:800,失败:900

message

String

描述状态

returnObj

String

返回对象。此参数所包含的参数请见“响应示例"里面的注释

返回值returnObj参数说明

响应参数

参数类型

描述

data

Map<String/*ConsuemGroup*/, ConsumerConnection>

订阅组客户端连接数据

返回值group参数说明

响应参数

参数类型

描述

connectionSet

HashSet<Connection>

连接列表

subscriptionTable

ConcurrentMap<String, SubscriptionData>

订阅组数据

consumeType

ConsumeType

消费类型

CONSUME_ACTIVELY("PULL")

CONSUME_PASSIVELY("PUSH")

messageModel

MessageModel

消费模式

BROADCASTING("BROADCASTING")

CLUSTERING("CLUSTERING")

返回值Connection参数说明

响应参数

参数类型

描述

clientId

String

客户端实例ID

clientAddr

String

客户端地址

language

List

客户端语言

JAVA((byte)0),

    CPP((byte)1),

    DOTNET((byte)2),

    PYTHON((byte)3),

    DELPHI((byte)4),

    ERLANG((byte)5),

    RUBY((byte)6),

    OTHER((byte)7),

    HTTP((byte)8),

    GO((byte)9),

    PHP((byte)10)

version

List

版本号

返回值SubscriptionData参数说明

响应参数

参数类型

描述

topic

String

主题

subString

String

Broker名称

tagsSet

List

Tag列表

codeSet

List

Code列表

subversion

Long

订阅时间戳

 

请求示例

GET https://[endpoint].ctapi.ctyun.cn/v2/consumer/connection?prodInstId=70687660456281088&groupName=group

响应成功示例

{

    "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": "...",

    "statusCode": "900"

}


MEn5gbXkC5YK