调用OnsConsumerStatus查询Group ID消费状态-云消息队列 RocketMQ 版-阿里云-云消息队列 RocketMQ 版(RocketMQ)-阿里云帮助中心

查询指定Group ID详细状态数据：订阅关系检查、消费TPS统计、负载均衡状态、消费端连接。

接口说明

重要阿里云提供的 OpenAPI 属于管控类 API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖 OpenAPI 实现，否则可能会导致链路产生风险。

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mq:QueryConsumerStatus

get

Group

acs:mq:{#regionId}:{#accountId}:{#GroupName}

Group

acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}

无

mq:OnsInstanceBaseInfo

请求参数

名称	类型	必填	描述	示例值
GroupId	string	是	需要查询的消费端 Group ID。	GID_test_group_id
Detail	boolean	否	是否查询详细信息。取值说明如下： true：要查询详细信息，即可获取返回参数 ConsumerConnectionInfoList 和 DetailInTopicList 信息。 false：默认值，不查询详细信息，即返回参数 ConsumerConnectionInfoList 和 DetailInTopicList 为空。	true
NeedJstack	boolean	否	是否打印 Jstack 信息。取值说明如下： true：要打印 Jstack 信息，可在 Jstack 返回参数中获取堆栈信息。说明如需打印 Jstack 信息，请确保您的入参 Detail 设置为 true。 false：默认值，不打印 Jstack 信息，Jstack 返回参数为空。	true
InstanceId	string	否	需查询的 Group ID 所对应的实例 ID。	MQ_INST_111111111111_DOxxxxxx

返回参数

名称	类型	描述	示例值
	object
RequestId	string	公共参数，每个请求的 ID 都是唯一的，可用于排查和定位问题。	10EDC518-10E7-4B34-92FB-171235FA****
Data	object	查询结果。
ConsumeTps	number	总消费 TPS。	0
ConsumeModel	string	消费模型。取值说明如下： CLUSTERING：集群消费模式 BROADCASTING：广播消费模式两种订阅模式的详细信息，请参见集群消费和广播消费。	CLUSTERING
ConnectionSet	object
ConnectionDo	array<object>	该集群当前在线客户端信息。
	object
RemoteIP	string	宿主机 IP 地址或公网 IP 地址。	42.120.74.**
Version	string	消费端版本。	V4_3_6_SNAPSHOT
ClientAddr	string	该消费实例的地址和端口。	30.5.121.**
Language	string	消费端语言。	JAVA
ClientId	string	消费实例的 ID。	30.5.121.**@25560#-1999745829#-1737591554#458773089270275
TotalDiff	integer	集群总的消费堆积。	197
ConsumerConnectionInfoList	object
ConsumerConnectionInfoDo	array<object>	该集群在线客户端详细信息，包含 Jstack、消费 RT 时间等信息。如需获取详细信息，请确保将 Detail 请求参数设置为 true。否则返回值为空。
	array<object>	test，此内容不推送到 icms
ConsumeModel	string	消费模型。取值说明如下： CLUSTERING：集群消费模式 BROADCASTING：广播消费模式两种订阅模式的详细信息，请参见集群消费和广播消费。	CLUSTERING
RunningDataList	object
ConsumerRunningDataDo	array<object>	实时状态统计。
	object
Rt	number	消费 RT 时间，单位：毫秒。	0
Topic	string	订阅的 Topic 名称。	test-mq_topic
FailedCountPerHour	integer	每小时内消费失败的消息数统计。	0
OkTps	number	消费消息成功的 TPS 统计。	0
FailedTps	number	消费消息失败的 TPS 统计。	0
SubscriptionSet	object
SubscriptionData	array<object>	订阅关系集合。
	array<object>
SubString	string	订阅该 Topic 的子类别 Tag 表达式。	*
SubVersion	integer	订阅关系版本号，为自增 Long 型。	1570701364301
Topic	string	订阅的 Topic 名称。	test-mq_topic
TagsSet	object
Tag	array	订阅的 Tag 集合。
	string	订阅的 Tag 集合。	ff
Jstack	object
ThreadTrackDo	array<object>	Jstack 堆栈信息。如需获取 Jstack 信息，请确保将 NeedJstack 入参设置为 true。否则返回值为空。
	array<object>	test——此内容不发布 icms
TrackList	object
Track	array	Jstack 堆栈信息字符串。
	string	Jstack 堆栈信息字符串。	TID: 52 STATE: WAITING
Thread	string	线程名称。	ConsumeMessageThread_0
LastTimeStamp	integer	最后消费时间。该参数值的格式为毫秒级 Unix 时间戳。	1570701368114
StartTimeStamp	integer	消费开始时间。该参数值的格式为毫秒级 Unix 时间戳。	1570701361528
Language	string	客户端语言。	JAVA
ClientId	string	消费实例的 ID。	30.5..@25560#-1999745829#-1737591554#458773089270275
Connection	string	连接信息。	**
Version	string	客户端版本号。	V4_3_6
ConsumeType	string	消费者消费消息的模式。取值说明如下： PUSH：云消息队列 RocketMQ 版服务端主动向消费者推送消息。 PULL：消费者主动向云消息队列 RocketMQ 版服务端拉取消息。	PUSH
ThreadCount	integer	消费线程数。	20
InstanceId	string	实例 ID。	MQ_INST_111111111111_DOxxxxxx
DetailInTopicList	object
DetailInTopicDo	array<object>	各个 Topic 的消费情况。如需获取详细信息，请确保将 Detail 请求参数设置为 true。否则返回值为空。
	object
DelayTime	integer	指定 Topic 的消费延迟时间。单位：毫秒。	0
TotalDiff	integer	该 Topic 消费总堆积数。	0
LastTimestamp	integer	最后消费时间。该参数值的格式为毫秒级 Unix 时间戳。	1570701259403
Topic	string	Topic 名称。	test-mq_topic
SubscriptionSame	boolean	订阅关系是否一致。	true
DelayTime	integer	指定 Group ID 所订阅的所有 Topic 中的最大消费延时时间。单位：毫秒。	100857
LastTimestamp	integer	最后消费时间。该参数值的格式为毫秒级 Unix 时间戳。	1566883844954
Online	boolean	是否在线。	true
RebalanceOK	boolean	客户端 Rebalance 是否正常。取值说明如下： true：正常 false：不正常	true

示例

正常返回示例

JSON格式

{
  "RequestId": "10EDC518-10E7-4B34-92FB-171235FA****",
  "Data": {
    "ConsumeTps": 0,
    "ConsumeModel": "CLUSTERING",
    "ConnectionSet": {
      "ConnectionDo": [
        {
          "RemoteIP": "42.120.74.**",
          "Version": "V4_3_6_SNAPSHOT",
          "ClientAddr": "30.5.121.**",
          "Language": "JAVA",
          "ClientId": "30.5.121.**@25560#-1999745829#-1737591554#458773089270275"
        }
      ]
    },
    "TotalDiff": 197,
    "ConsumerConnectionInfoList": {
      "ConsumerConnectionInfoDo": [
        {
          "ConsumeModel": "CLUSTERING",
          "RunningDataList": {
            "ConsumerRunningDataDo": [
              {
                "Rt": 0,
                "Topic": "test-mq_topic",
                "FailedCountPerHour": 0,
                "OkTps": 0,
                "FailedTps": 0
              }
            ]
          },
          "SubscriptionSet": {
            "SubscriptionData": [
              {
                "SubString": "*",
                "SubVersion": 1570701364301,
                "Topic": "test-mq_topic",
                "TagsSet": {
                  "Tag": [
                    "ff"
                  ]
                }
              }
            ]
          },
          "Jstack": {
            "ThreadTrackDo": [
              {
                "TrackList": {
                  "Track": [
                    "TID: 52 STATE: WAITING"
                  ]
                },
                "Thread": "ConsumeMessageThread_0"
              }
            ]
          },
          "LastTimeStamp": 1570701368114,
          "StartTimeStamp": 1570701361528,
          "Language": "JAVA",
          "ClientId": "30.5.**.**@25560#-1999745829#-1737591554#458773089270275",
          "Connection": "**",
          "Version": "V4_3_6",
          "ConsumeType": "PUSH",
          "ThreadCount": 20
        }
      ]
    },
    "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
    "DetailInTopicList": {
      "DetailInTopicDo": [
        {
          "DelayTime": 0,
          "TotalDiff": 0,
          "LastTimestamp": 1570701259403,
          "Topic": "test-mq_topic"
        }
      ]
    },
    "SubscriptionSame": true,
    "DelayTime": 100857,
    "LastTimestamp": 1566883844954,
    "Online": true,
    "RebalanceOK": true
  }
}

错误码

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

变更历史

更多信息，参考变更详情。