调用 DescribeConsumerGroupLag 接口，查询 Group 消费堆积详情。 ## 调试 [去调试](https://api.volcengine.com/api-explorer/?action=DescribeConsumerGroupLag&groupName=Group%E7%AE%A1%E7%90%86&serviceCode=RocketMQ&version=2023-01-01) ## 请求参数下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见[公共参数](https://www.volcengine.com/docs/6369/67268)。 **Action** string 必选 `示例值：DescribeConsumerGroupLag` 要执行的操作，取值：DescribeConsumerGroupLag。 **Version** string 必选 `示例值：2023-01-01` API的版本，取值：2023\-01\-01。 **LiteTopic** string `可选` `示例值：lite-test_1` LiteTopic 名称，指定时仅查询该 LiteTopic 的堆积信息。 **InstanceId** string 必选 `示例值：rocketmq-cnai1f0c29ca****` 实例 ID。 **GroupId** string 必选 `示例值：GID_test` 根据 Group 的 ID 筛选。支持模糊查询。 ## 返回参数下方仅列出本接口特有的返回参数。更多信息请参见[返回结构](https://www.volcengine.com/docs/6369/80336)。 **TotalLag** object `示例值：{ "ReadyCount": 100, "DeliveryDuration": 90, "LastConsumeTimestamp": 1715846430000 }` 总堆积量。 **ReadyCount** long `示例值：100` 未消费消息数。 **DeliveryDuration** long `示例值：90` 投递延迟时间，单位为秒。 **LastConsumeTimestamp** string `示例值：1715846430000` 最后消费时间戳，单位为毫秒。 **TopicLagMap** object `示例值：{ "test_topic": { "ReadyCount": 100, "DeliveryDuration": 90, "LastConsumeTimestamp": 1715846430000 } }` 普通 Topic 的堆积信息。 **LiteTopicLagMap** object `示例值：{ "test_lite_topic": { "ReadyCount": 100, "DeliveryDuration": 90 } }` LiteTopic 的堆积信息。 ## 请求示例 ```json POST /?Action=DescribeConsumerGroupLag&Version=2023-01-01 HTTP/1.1 Content-Type: application/json Host: rocketmq.volcengineapi.com X-Date: 20210328T100802Z Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-shanghai/rocketmq/request, SignedHeaders=x-date, Signature=******** { "InstanceId": "rocketmq-cnai81fd122a****", "GroupId": "GID_test", "LiteTopic": "test_lite_topic" } ``` ## 返回示例 ```json { "ResponseMetadata": { "RequestId": "202103281008020102121461940900****", "Action": "DescribeConsumerGroupLag", "Version": "2023-01-01", "Service": "rocketmq", "Region": "cn-shanghai" }, "Result": { "TotalLag": { "ReadyCount": 100, }, "TopicLagMap": {}, "LiteTopicLagMap": { "test_lite_topic": { "ReadyCount": 100, "DeliveryDuration": 90, } } } } ``` ## 错误码下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见[公共错误码](https://www.volcengine.com/docs/6369/68677)文档。 |状态码 |错误码 |错误信息 |说明 | |---|---|---|---| |200 |OK |OK |成功。 | |400 |MissingParameter |The request body is missing a required parameter %s. |缺少%s参数。 | |400 |UnsupportedParameter |The specified parameter %s is unsupported. |不支持%s参数。 | |400 |InvalidParameter |The specified parameter %s is not valid. |参数值%s无效，请检查后重试。 | |400 |NotModifiedParameter |The resource was not changed. |未变更任何配置。 | |400 |InvalidPara |The specified parameter is not valid. |参数值无效。 | |403 |OperationDenied.AccountNotAuthorized |You are not authorized to perform this operation. |您不具备相关权限，请授权或切换账号后重试。 | |403 |OperationDenied.ResourceOccupied |The resource is busy now, please try again later. |资源繁忙，可能由于指定资源正在被访问或回收。 | |403 |OperationDenied.InvalidInstanceStatus |The operation is not valid for the current status of the instance. |当前实例状态不允许执行该操作。 | |403 |OperationDenied.VersionUnsupported |The current instance version does not support this operation.Please upgrade the instance and try again. |当前实例版本不支持指定操作，请升级实例后再试。 | |404 |InvalidInstanceId.NotFound |The specified Instance ID does not exist. |实例不存在。 | |404 |InvalidTopicName.NotFound |The specified topic does not exist. |Topic 不存在。 | |500 |InternalError |The request failed due to some unknown error, exception or failure. |内部错误，请稍后再试。 | |500 |ServerInternalError |The request failed due to some unknown error, exception or failure. |服务内部错误。 | |500 |ResourceIsBusy |The resource is busy now, please try again later. |资源繁忙，可能由于指定资源正在被访问或回收。 | |503 |ServiceUnavailable |The request failed due to a temporary failure of the server. |当前服务暂时不可用。 |

消息队列 RocketMQ版