:OnsConsumerStatus

Note

• You can call this operation in scenarios in which consumers are online while messages are queued. You can troubleshoot errors based on the information that is returned by this operation. You can check whether all consumers in the consumer group subscribe to the same topics and tags, and whether load balancing is performed as expected. You can also obtain the information about thread stack traces of online consumers.
• This operation uses multiple backend operations to query and aggregate data. The system requires a long period of time to process a request. We recommend that you do not frequently call this operation.

Request limit

Each Alibaba Cloud account can call this operation up to 10 times per second. If the number of requests that you send to call this operation within one second reaches the request limit, new requests fail. This may interrupt your business. For information about the request limit of each operation, see API request limits.

Authorization

By default, Alibaba Cloud accounts can call this operation. A Resource Access Management (RAM) user can call this operation only after the RAM user is granted the required permissions. The following table describes the permissions that must be granted to a RAM user to call this operation. For information about how to grant permissions, see Policies.

Request parameters

Response parameters

Examples

Sample requests

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsConsumerStatus
&GroupId=GID_test_group_id
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&NeedJstack=true
&Detail=true
&<Common request parameters>

Sample success responses

XML format

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 format

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****"
}

Error codes

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

Query details of a consumer group in the console

In the Message Queue for Apache RocketMQ console, you can query the details of a consumer group. For more information, see View the status of consumers.