OnsConsumerStatus

使用说明

• 本接口一般用于在粗略判断消费堆积以及客户端在线状态后，需要排查消费异常原因的场景。可以根据返回结果判断出指定Group ID的订阅关系是否一致、负载均衡是否正常以及获取在线客户端的Jstack信息等。
• 使用本接口需要调用大量后端接口以完成数据聚合，因此查询速度慢，不建议频繁调用。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

授权信息

默认仅限阿里云账号使用本接口，RAM用户只有在被授予了相关API操作权限后方可使用。本接口的授权信息如下表所示。更多信息，请参见权限策略和示例。

请求参数

返回数据

示例

请求示例

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsConsumerStatus
&GroupId=GID_test_group_id
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&NeedJstack=true
&Detail=true
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<OnsConsumerStatusResponse>
<data>
    <connectionSet>
        <bizVersion>V4_3_6</bizVersion>
        <clientAddr>30.5.***.*</clientAddr>
        <clientId>30.5.***.*@97730#-1999745829#-1737591554#729272961762836</clientId>
        <language>JAVA</language>
        <version>V4_3_6</version>
    </connectionSet>
    <consumeModel>CLUSTERING</consumeModel>
    <consumeTps>0</consumeTps>
    <consumerConnectionInfoList>
        <bizVersion>V4_3_6</bizVersion>
        <clientId>30.5.***.*@97730#-1999745829#-1737591554#729272961762836</clientId>
        <consumeType>PUSH</consumeType>
        <jstack>
            <thread>ConsumeMessageThread_4</thread>
            <trackList>TID: 44 STATE: WAITING</trackList>
            <trackList>sun.misc.Unsafe.park(Native Method)</trackList>
            <trackList>java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)</trackList>
            <trackList>java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject.await(AbstractQueuedSynchronizer.java:2039)</trackList>
            <trackList>java.util.concurrent.LinkedBlockingQueue.take(LinkedBlockingQueue.java:442)</trackList>
            <trackList>java.util.concurrent.ThreadPoolExecutor.getTask(ThreadPoolExecutor.java:1074)</trackList>
            <trackList>java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1134)</trackList>
            <trackList>java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)</trackList>
            <trackList>java.lang.Thread.run(Thread.java:748)</trackList>
        </jstack>
        <language>JAVA</language>
        <lastTimeStamp>1570701368114</lastTimeStamp>
        <runningDataList>
            <failedCountPerHour>0</failedCountPerHour>
            <failedTps>0</failedTps>
            <okTps>0</okTps>
            <rt>0</rt>
            <topic>test-mq_topic</topic>
        </runningDataList>
        <startTimeStamp>1570701361528</startTimeStamp>
        <subscriptionSet>
            <subString>*</subString>
            <subVersion>1570701364301</subVersion>
            <topic>test-mq_topic</topic>
        </subscriptionSet>
        <threadCount>20</threadCount>
        <version>V4_3_6</version>
    </consumerConnectionInfoList>
    <delayTime>0</delayTime>
    <detailInTopicList>
        <delayTime>0</delayTime>
        <lastTimestamp>1570701259403</lastTimestamp>
        <topic>test-mq_topic</topic>
        <totalDiff>0</totalDiff>
    </detailInTopicList>
    <instanceId>MQ_INST_111111111111_DOxxxxxx</instanceId>
    <lastTimestamp>1570701368114</lastTimestamp>
    <online>true</online>
    <rebalanceOK>true</rebalanceOK>
    <subscriptionSame>true</subscriptionSame>
    <totalDiff>0</totalDiff>
</data>
<requestId>10EDC518-10E7-4B34-92FB-171235FA****</requestId>
</OnsConsumerStatusResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "data" : {
    "connectionSet" : [ {
      "bizVersion" : "V4_3_6",
      "clientAddr" : "30.5.***.*",
      "clientId" : "30.5.***.*@97730#-1999745829#-1737591554#729272961762836",
      "language" : "JAVA",
      "version" : "V4_3_6"
    } ],
    "consumeModel" : "CLUSTERING",
    "consumeTps" : 0,
    "consumerConnectionInfoList" : [ {
      "bizVersion" : "V4_3_6",
      "clientId" : "30.5.***.*@97730#-1999745829#-1737591554#729272961762836",
      "consumeType" : "PUSH",
      "jstack" : [ {
        "thread" : "ConsumeMessageThread_1",
        "trackList" : [ "TID: 44 STATE: WAITING", "sun.misc.Unsafe.park(Native Method)", "java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)", "java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject.await(AbstractQueuedSynchronizer.java:2039)", "java.util.concurrent.LinkedBlockingQueue.take(LinkedBlockingQueue.java:442)", "java.util.concurrent.ThreadPoolExecutor.getTask(ThreadPoolExecutor.java:1074)", "java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1134)", "java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)", "java.lang.Thread.run(Thread.java:748)" ]
      } ],
      "language" : "JAVA",
      "lastTimeStamp" : 1570701368114,
      "runningDataList" : [ {
        "failedCountPerHour" : 0,
        "failedTps" : 0,
        "okTps" : 0,
        "rt" : 0,
        "topic" : "test-mq_topic"
      } ],
      "startTimeStamp" : 1570701361528,
      "subscriptionSet" : [ {
        "subString" : "*",
        "subVersion" : 1570701364301,
        "tagsSet" : [ ],
        "topic" : "test-mq_topic"
      } ],
      "threadCount" : 20,
      "version" : "V4_3_6"
    } ],
    "delayTime" : 0,
    "detailInTopicList" : [ {
      "delayTime" : 0,
      "lastTimestamp" : 1570701259403,
      "topic" : "test-mq_topic",
      "totalDiff" : 0
    } ],
    "instanceId" : "MQ_INST_111111111111_DOxxxxxx",
    "lastTimestamp" : 1570701368114,
    "online" : true,
    "rebalanceOK" : true,
    "subscriptionSame" : true,
    "totalDiff" : 0
  },
  "requestId" : "10EDC518-10E7-4B34-92FB-171235FA****"
}

错误码

访问错误中心查看更多错误码。

控制台操作

除了调用OnsConsumerStatus接口，您还可以通过消息队列RocketMQ版控制台查看Group ID的详细数据。具体操作，请参见查看消费者状态。