OnsConsumerStatus

Note the following when calling the OnsConsumerStatus operation:

• The OnsConsumerStatus operation is usually applicable to scenarios where you want to locate causes for consumption exceptions after roughly ruling out message accumulation and the online status of consumer instances. Based on the responses, you can determine whether the subscriptions of consumer instances with a specified group ID are consistent and whether load balancing is normal, and obtain Jstack information of online consumer instances.
• The OnsConsumerStatus operation needs to call a large number of backend API operations to aggregate data. Therefore, the query is slow. We recommend that you do not call this operation frequently.

Request parameters

Response parameters

Examples

Sample requests

http(s)://[Endpoint]/? Action=OnsConsumerStatus
&GroupId=GID_test_group_id
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&NeedJstack=true
&Detail=true
&<Common request parameters>

Sample success responses

XML format

<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-171235FA6E38</requestId>
</OnsConsumerStatusResponse>

JSON format

{
  "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-171235FA6E38"
}

Error codes

For a list of error codes, visit the API Error Center.