GET https://[endpoint].ctapi.ctyun.cn/v2/consumer/status
请求参数
请求参数 | 是否必填 | 位置 | 参数类型 | 说明 |
prodInstId | 是 | url | String | 实例ID |
group | 是 | url | String | 订阅组名字 |
clientId | 是 | url | String | 客户端ID |
响应参数
响应参数 | 参数类型 | 描述 |
statusCode | String | 接口系统层面状态码。成功：800，失败：900 |
message | String | 描述状态 |
returnObj | String | 返回对象。此参数所包含的参数请见“响应示例"里面的注释 |
返回值returnObj参数说明
响应参数 | 参数类型 | 描述 |
data | Json | 消费者详情 |
返回值data参数说明
响应参数 | 参数类型 | 描述 |
properties | Properties | 订阅组属性 |
subscriptionSet | TreeSet<SubscriptionData> | 订阅组数据 |
mqTable | TreeMap<MessageQueue, ProcessQueueVo> | 队列信息 |
statusTable | TreeMap<String, ConsumeStatusVo> | 消费状态信息 |
返回值subscriptionSet参数说明
响应参数 | 参数类型 | 描述 |
topic | String | 主题 |
subString | String | 订阅串 |
tagsSet | List | Tag列表 |
codeSet | List | Code列表 |
返回值MessageQueue参数说明
响应参数 | 参数类型 | 描述 |
topic | String | 主题 |
brokerName | String | Broker名称 |
queueId | Integer | 队列id |
返回值ConsumeStatusVo主要参数说明
响应参数 | 参数类型 | 描述 |
commitOffset | Long | 物理偏移量 |
lastPullTimestamp | String | Broker名称 |
lastConsumeTimestamp | Integer | 队列id |
返回值ProcessQueueVo主要参数说明
响应参数 | 参数类型 | 描述 |
pullRT | Double | 拉取消息耗时（毫秒） |
pullTPS | Double | 拉取消息tps |
consumeRT | Double | 消费耗时（毫秒） |
consumeOKTPS | Double | 消费成功tps |
consumeFailedTPS | Double | 消费失败tps |
consumeFailedMsgs | 消费失败消息数 |
请求示例
GET https://[endpoint].ctapi.ctyun.cn/v2/consumer/status?prodInstId=70687660456281088&groupName=group&clientId=5.5.148.141@test_instance
响应成功示例
{
"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": "...",
"statusCode": "900"
}