查询指定Group ID的消息消费堆积情况,包括当前消息堆积数量和消费延迟时间等。
接口说明
注意 阿里云提供的 OpenAPI 属于管控类 API,用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成,消息收发的核心数据链路中严禁依赖 OpenAPI 实现,否则可能会导致链路产生风险。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
mq:QueryConsumerAccumulate | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
GroupId | string | 是 | 需查询的消费端 Group ID。 | GID_test_consumer_id |
Detail | boolean | 否 | 是否查询各个 Topic 的详细信息。取值说明如下:
| true |
InstanceId | string | 是 | 实例 ID。 | MQ_INST_111111111111_DOxxxxxx |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "CE817BFF-B389-43CD-9419-95011AC9****",
"Data": {
"ConsumeTps": 10,
"DelayTime": 10000,
"LastTimestamp": 1566231000000,
"TotalDiff": 100,
"Online": true,
"DetailInTopicList": {
"DetailInTopicDo": [
{
"DelayTime": 10000,
"TotalDiff": 100,
"LastTimestamp": 1566231000000,
"Topic": "test-mq-topic"
}
]
}
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史
控制台操作
除了调用 OnsConsumerAccumulate 接口,您还可以通过云消息队列 RocketMQ 版控制台查看 Group ID 的消息消费堆积情况。具体操作,请参见查看消费者状态。