接口功能介绍

查询订阅组详细状态信息

接口约束

无

URI

GET /v3/consumer/status

路径参数 无

Query参数

参数	是否必填	参数类型	说明
prodInstId	是	String	实例ID
groupName	是	String	订阅组名字
clientId	是	String	客户端ID

请求参数

请求头header参数

参数	是否必填	参数类型	说明	示例	下级对象
regionId	是	String	资源池编码	200000002368

请求体body参数 无

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	String	接口系统层面状态码。成功：800，失败：900	800
message	String	描述状态
returnObj	Object	返回对象		returnObj
error	String	错误码，只有非成功才有这个字段，方便快速定位问题	201
表 returnObj

参数	参数类型	说明	示例	下级对象
data	Object	消费组详情数据		data
表 data

参数	参数类型	说明	示例	下级对象
properties	Object	消费组配置属性		properties
subscriptionSet	Array of Objects	订阅关系集合		subscriptionSet
mqTable	Object	消息队列信息表		mqTable
statusTable	Object	消费状态统计表		statusTable
jstack	String	线程堆栈信息	null
表 properties

参数	参数类型	说明	示例
maxReconsumeTimes	String	最大重试次数	-1
adjustThreadPoolNumsThreshold	String	线程池数量调整阈值	100000
unitMode	String	单元模式开关	false
consumeTimeoutInSec	String	消费超时时间（秒）	-1
timeoutStrategy	String	超时处理策略	ALARM_AND_RETRY
consumerGroup	String	消费组名称	group
messageModel	String	消息模型	CLUSTERING
allocateMessageQueueStrategy	String	消息队列分配策略	org.apache.rocketmq.client.consumer.rebalance.AllocateMessageQueueAveragely@14978a04
pullThresholdSizeForTopic	String	主题拉取大小阈值	-1
suspendCurrentQueueTimeMillis	String	队列挂起时间（毫秒）	1000
pullThresholdSizeForQueue	String	队列拉取大小阈值	100
PROP_CLIENT_VERSION	String	客户端版本	V2_8_3_CTG
offsetStore	String	偏移量存储实现类	org.apache.rocketmq.client.consumer.store.RemoteBrokerOffsetStore@64668c91
consumeConcurrentlyMaxSpan	String	并发消费最大跨度	2000
postSubscriptionWhenPull	String	拉取时提交订阅关系开关	false
consumeTimestamp	String	消费时间戳	20220831110532
PROP_CONSUME_TYPE	String	消费类型	CONSUME_PASSIVELY
consumeMessageBatchMaxSize	String	批量消费最大消息数	1
defaultMQPushConsumerImpl	String	推送消费者实现类	org.apache.rocketmq.client.impl.consumer.DefaultMQPushConsumerImpl@6470d9c8
PROP_THREADPOOL_CORE_SIZE	String	线程池核心大小	20
pullInterval	String	拉取间隔（毫秒）	0
pullThresholdForQueue	String	队列拉取阈值	1000
pullThresholdForTopic	String	主题拉取阈值	-1
consumeFromWhere	String	消费起始位置	CONSUME_FROM_FIRST_OFFSET
PROP_NAMESERVER_ADDR	String	名称服务地址	192.168.71.188:8411;
pullBatchSize	String	拉取批次大小	32
consumeThreadMin	String	最小消费线程数	20
PROP_CONSUMER_START_TIMESTAMP	String	消费者启动时间戳	1661916932150
consumeThreadMax	String	最大消费线程数	64
consumeTimeout2	String	消费超时时间2（秒）	15
subscription	String	订阅关系	{}
PROP_CONSUMEORDERLY	String	顺序消费开关	false
messageListener	String	消息监听器实现类	com.ctg.mq.api.impl.MQConsumerImpl$ConsumerTopicListenerImpl@677658a0
表 subscriptionSet

参数	参数类型	说明	示例
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
表 mqTable

参数	参数类型	说明	示例
commitOffset	Long	提交偏移量	6
cachedMsgMinOffset	Long	缓存消息最小偏移量	0
cachedMsgMaxOffset	Long	缓存消息最大偏移量	0
cachedMsgCount	Integer	缓存消息数量	0
cachedMsgSizeInMiB	Integer	缓存消息大小（MiB）	0
transactionMsgMinOffset	Long	事务消息最小偏移量	0
transactionMsgMaxOffset	Long	事务消息最大偏移量	0
transactionMsgCount	Integer	事务消息数量	0
locked	Boolean	是否锁定	false
tryUnlockTimes	Integer	解锁尝试次数	0
lastLockTimestamp	Long	最后锁定时间戳	1661916951284
droped	Boolean	是否删除	false
lastPullTimestamp	Long	最后拉取时间戳	1661929388688
lastConsumeTimestamp	Long	最后消费时间戳	1661916951284
表 statusTable

参数	参数类型	说明
pullRT	Integer	拉取响应时间（毫秒）
pullTPS	Integer	拉取TPS
consumeRT	Integer	消费响应时间（毫秒）
consumeOKTPS	Integer	消费成功TPS
consumeFailedTPS	Integer	消费失败TPS
consumeFailedMsgs	Integer	消费失败消息数

枚举参数

无

请求示例

请求url

https://[endpoint].ctapi.ctyun.cn/v3/consumer/status?prodInstId=70687660456281088&groupName=group&clientId=5.5.148.141@test_instance

请求头header

无

请求体body

无

响应示例

响应成功示例
{
    "returnObj":{
        "data":{
            "properties":{
                "maxReconsumeTimes":"-1",
                "adjustThreadPoolNumsThreshold":"100000",
                "unitMode":"false",
                "consumeTimeoutInSec":"-1",
                "timeoutStrategy":"ALARM_AND_RETRY",
                "consumerGroup":"group",
                "messageModel":"CLUSTERING",
                "allocateMessageQueueStrategy":"org.apache.rocketmq.client.consumer.rebalance.AllocateMessageQueueAveragely@14978a04",
                "pullThresholdSizeForTopic":"-1",
                "suspendCurrentQueueTimeMillis":"1000",
                "pullThresholdSizeForQueue":"100",
                "PROP_CLIENT_VERSION":"V2_8_3_CTG",
                "offsetStore":"org.apache.rocketmq.client.consumer.store.RemoteBrokerOffsetStore@64668c91",
                "consumeConcurrentlyMaxSpan":"2000",
                "postSubscriptionWhenPull":"false",
                "consumeTimestamp":"20220831110532",
                "PROP_CONSUME_TYPE":"CONSUME_PASSIVELY",
                "consumeMessageBatchMaxSize":"1",
                "defaultMQPushConsumerImpl":"org.apache.rocketmq.client.impl.consumer.DefaultMQPushConsumerImpl@6470d9c8",
                "PROP_THREADPOOL_CORE_SIZE":"20",
                "pullInterval":"0",
                "pullThresholdForQueue":"1000",
                "pullThresholdForTopic":"-1",
                "consumeFromWhere":"CONSUME_FROM_FIRST_OFFSET",
                "PROP_NAMESERVER_ADDR":"192.168.71.188:8411;",
                "pullBatchSize":"32",
                "consumeThreadMin":"20",
                "PROP_CONSUMER_START_TIMESTAMP":"1661916932150",
                "consumeThreadMax":"64",
                "consumeTimeout2":"15",
                "subscription":"{}",
                "PROP_CONSUMEORDERLY":"false",
                "messageListener":"com.ctg.mq.api.impl.MQConsumerImpl$ConsumerTopicListenerImpl@677658a0"
            },
            "subscriptionSet":[
                {
                    "classFilterMode":false,
                    "topic":"%RETRY%group",
                    "subString":"*",
                    "tagsSet":[
                    ],
                    "codeSet":[
                    ],
                    "subVersion":1661916951262,
                    "expressionType":null,
                    "filterClassSource":null
                },
                {
                    "classFilterMode":false,
                    "topic":"test",
                    "subString":"*",
                    "tagsSet":[
                    ],
                    "codeSet":[
                    ],
                    "subVersion":1661916951326,
                    "expressionType":null,
                    "filterClassSource":null
                }
            ],
            "mqTable":{
                "MessageQueue [topic=%RETRY%group, brokerName=mq_test_broker_1, queueId=0]":{
                    "commitOffset":0,
                    "cachedMsgMinOffset":0,
                    "cachedMsgMaxOffset":0,
                    "cachedMsgCount":0,
                    "cachedMsgSizeInMiB":0,
                    "transactionMsgMinOffset":0,
                    "transactionMsgMaxOffset":0,
                    "transactionMsgCount":0,
                    "locked":false,
                    "tryUnlockTimes":0,
                    "lastLockTimestamp":1661916951245,
                    "droped":false,
                    "lastPullTimestamp":1661929387746,
                    "lastConsumeTimestamp":1661916951245
                },
                "MessageQueue [topic=test, brokerName=mq_test_broker_1, queueId=0]":{
                    "commitOffset":6,
                    "cachedMsgMinOffset":0,
                    "cachedMsgMaxOffset":0,
                    "cachedMsgCount":0,
                    "cachedMsgSizeInMiB":0,
                    "transactionMsgMinOffset":0,
                    "transactionMsgMaxOffset":0,
                    "transactionMsgCount":0,
                    "locked":false,
                    "tryUnlockTimes":0,
                    "lastLockTimestamp":1661916951284,
                    "droped":false,
                    "lastPullTimestamp":1661929388688,
                    "lastConsumeTimestamp":1661916951284
                },
                "MessageQueue [topic=test, brokerName=mq_test_broker_1, queueId=1]":{
                    "commitOffset":6,
                    "cachedMsgMinOffset":0,
                    "cachedMsgMaxOffset":0,
                    "cachedMsgCount":0,
                    "cachedMsgSizeInMiB":0,
                    "transactionMsgMinOffset":0,
                    "transactionMsgMaxOffset":0,
                    "transactionMsgCount":0,
                    "locked":false,
                    "tryUnlockTimes":0,
                    "lastLockTimestamp":1661916951307,
                    "droped":false,
                    "lastPullTimestamp":1661929388580,
                    "lastConsumeTimestamp":1661916951307
                },
                "MessageQueue [topic=test, brokerName=mq_test_broker_1, queueId=2]":{
                    "commitOffset":7,
                    "cachedMsgMinOffset":0,
                    "cachedMsgMaxOffset":0,
                    "cachedMsgCount":0,
                    "cachedMsgSizeInMiB":0,
                    "transactionMsgMinOffset":0,
                    "transactionMsgMaxOffset":0,
                    "transactionMsgCount":0,
                    "locked":false,
                    "tryUnlockTimes":0,
                    "lastLockTimestamp":1661916951295,
                    "droped":false,
                    "lastPullTimestamp":1661929388691,
                    "lastConsumeTimestamp":1661916951295
                },
                "MessageQueue [topic=test, brokerName=mq_test_broker_1, queueId=3]":{
                    "commitOffset":8,
                    "cachedMsgMinOffset":0,
                    "cachedMsgMaxOffset":0,
                    "cachedMsgCount":0,
                    "cachedMsgSizeInMiB":0,
                    "transactionMsgMinOffset":0,
                    "transactionMsgMaxOffset":0,
                    "transactionMsgCount":0,
                    "locked":false,
                    "tryUnlockTimes":0,
                    "lastLockTimestamp":1661916951317,
                    "droped":false,
                    "lastPullTimestamp":1661929388688,
                    "lastConsumeTimestamp":1661916951317
                }
            },
            "statusTable":{
                "%RETRY%group":{
                    "pullRT":0,
                    "pullTPS":0,
                    "consumeRT":0,
                    "consumeOKTPS":0,
                    "consumeFailedTPS":0,
                    "consumeFailedMsgs":0
                },
                "test":{
                    "pullRT":0,
                    "pullTPS":0,
                    "consumeRT":0,
                    "consumeOKTPS":0,
                    "consumeFailedTPS":0,
                    "consumeFailedMsgs":0
                }
            },
            "jstack":null
        }
    },
    "message":"success",
    "statusCode":800
}
响应失败示例
{
    "returnObj": {},
    "message": "...",
    "error":"201",
    "statusCode": "900"
}

状态码

请参考状态码

错误码

请参考错误码

息壤智算

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

分布式消息服务RocketMQ

分布式消息服务RocketMQ

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

息壤智算

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

分布式消息服务RocketMQ

分布式消息服务RocketMQ

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码