查询消费者组堆积信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rocketmq:GetConsumerGroupLag | get | *ConsumerGroup acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId} |
| 无 |
请求语法
GET /instances/{instanceId}/consumerGroups/{consumerGroupId}/lag HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceId | string | 是 | 实例 ID。 | rmq-cn-2r42vrvde0j |
| consumerGroupId | string | 是 | 消费者分组 ID。 | CID-TEST |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "F5764C40-FB8C-53AE-B95D-96AB3D0E9375",
"success": true,
"data": {
"regionId": "cn-hangzhou",
"instanceId": "rmq-cn-7e22ody****",
"consumerGroupId": "CID-TEST",
"totalLag": {
"readyCount": 1,
"inflightCount": 1,
"deliveryDuration": 12,
"lastConsumeTimestamp": 0
},
"topicLagMap": {
"key": {
"readyCount": 1,
"inflightCount": 1,
"deliveryDuration": 12
}
}
},
"code": "Topic.NotFound",
"message": "Parameter instanceId is mandatory for this action .",
"httpStatusCode": 200,
"dynamicCode": "InstanceId",
"dynamicMessage": "instanceId"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-12-20 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-11-26 | OpenAPI 返回结构发生变更 | 查看变更详情 |