OnsConsumerAccumulate_云消息队列 RocketMQ 4.0 版_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

注意 阿里云提供的 OpenAPI 属于管控类 API,用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成,消息收发的核心数据链路中严禁依赖 OpenAPI 实现,否则可能会导致链路产生风险。
消费堆积查询一般在生产环境中需要关注 Group ID 消费进度时使用,用于粗略判断消息消费情况和延迟情况。您不仅可以查到该 Group ID 订阅的所有 Topic 的消息堆积情况,还可以查到每个 Topic 各自的消息堆积情况。

流控信息

请求速率为10/1(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
mq:QueryConsumerAccumulate
Get
Group
acs:mq:{#regionId}:{#accountId}:{#GroupName}
Group
acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}
mq:OnsInstanceBaseInfo

请求参数

字段名称字段详情
GroupIdstring

需查询的消费端 Group ID。

示例值:GID_test_consumer_id参考取值来源:
    OnsGroupList
Detailboolean

是否查询各个 Topic 的详细信息。取值说明如下:展开详情

示例值:true
InstanceIdstring

实例 ID。

示例值:MQ_INST_111111111111_DOxxxxxx参考取值来源:
    OnsInstanceBaseInfo

返回参数

字段名称字段详情
RequestIdstring

公共参数,每个请求的 ID 都是唯一的,可用于排查和定位问题。

示例值:CE817BFF-B389-43CD-9419-95011AC9****
Dataobject

指定 Consumer 的消费堆积情况。

返回示例

变更历史

暂无变更历史

相关示例