调用 DescribeGroupsDetail 接口查看指定 Group 的详细信息。

使用说明

DescribeGroupsDetail 接口用于查看指定 Group 的详细信息，包括消费组状态、消费模式等。

注意事项

请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeGroupsDetail

要执行的操作，取值：DescribeGroupsDetail。

Version string 必选示例值：2023-01-01

API的版本，取值：2023-01-01。

InstanceId string 必选示例值：rocketmq-cnai1f0c29ca****

实例 ID。

GroupId string 必选示例值：GID_test

待查看 Group 详情的 Group ID。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

LastUpdateTimestamp string 示例值：1661320625

最后更新时间。

ConsumeMessageOrderly boolean 示例值：true

是否顺序消费。

RetryMaxTimes integer 示例值：1

消费最大重试次数。

RocketmqVersion string 示例值：4.8

版本。

ServiceStatus string 示例值：Running

服务状态。

ReadEnable boolean 示例值：false

是否开启读取。

CreateTime string 示例值：2022-11-29T11:13:11Z

Group 的创建时间。

Description string 示例值：test

Group 的简单描述。

GroupId string 示例值：GID_test

消费组 ID。

GroupType string 示例值：TCP

Group 适用的协议。取值说明如下：

TCP：表示 Group ID 仅适用于 TCP 协议的消息收发。

IsSubSame boolean 示例值：true

Group 内消费者实例群组的订阅关系是否一致。

true：一致

false：不一致

MessageDelayTime string 示例值：0

消息延迟时间，消费者实例群组最早的一条未消费消息的生产时间与当前时间的差值。单位为毫秒。

MessageModel string 示例值：Clustering

消息消费模式。默认为集群模式，您也可以在 Consumer 客户端中指定消费模式为广播模式。

说明

请勿在同一 Group 下同时配置集群模式和广播模式。

Clustering：集群消费模式

Broadcasting：广播消费模式

Status string 示例值：Online

消费组状态。

Online：消费中

Offline：未消费

TotalConsumedRate string 示例值：827.05

该 Group 下消费者实例群组接收消息的总 TPS，单位为条/秒。

TotalDiff integer 示例值：0

消费者实例群组的未消费消息的总量。

此处显示的消息堆积量为未过滤 Tag 的总堆积量，包括 Topic 下所有 Tag 的消息。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	OK	OK	成功。
400	InvalidGroupId_AlreadyExists	The specified group name already exists.	Group 名称已存在。
400	InvalidTopicName_AlreadyExists	The specified topic name already exists.	Topic 名称已存在。
400	NotModifiedParameter	The resource was not changed.	未变更任何配置。
400	InvalidParameter	The specified parameter %s is not valid.	参数值%s无效，请检查后重试。
400	UnsupportedParameter	The specified parameter %s is unsupported.	不支持%s参数。
400	MissingParameter	The request body is missing a required parameter %s.	缺少%s参数。
400	OperationDenied_InvalidRequest	The request that you specified is not valid.	请求异常，请检查后重试。
400	QuotaExceeded_InstanceNumber	The number of instances exceeds the limit.	实例数量超出上限。
400	QuotaExceeded_AuthKeyNumber	The number of authKeys exceeds the limit.	密钥数量超出上限。
400	QuotaExceeded_TopicNumber	The number of topic exceeds the limit.	Topic 数量超出上限。
400	QuotaExceeded_GroupNumber	The number of group exceeds the limit.	Group 数量超出上限。
400	QuotaExceeded_QueueNumber	The number of queue exceeds the limit.	队列数量超出上限。
400	OperationDenied.InvalidRequest	The request that you specified is not valid.	请求异常，请检查后重试。
400	InvalidPara	The specified parameter is not valid.	参数值无效。
403	OperationDenied_AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
403	OperationDenied_InternetAccessEnabled	Internet access is enabled for the instance.	该实例已开启公网访问方式。
403	OperationDenied_InternetAccessDisabled	Internet access is disabled for the instance.	该实例未开启公网访问方式。
403	OperationDenied_InvalidInstanceStatus	The operation is not valid for the current status of the instance.	当前实例状态不允许执行该操作。
403	OperationDenied_TaskIsRunning	An operation is currently in progress. Try again later.	后台任务正在运行中，请稍后再试。
403	OperationDenied_InstanceNotEmpty	The instance that you tried to delete is not empty.	期望删除的实例资源不为空。
403	OperationDenied_ResourceOccupied	The resource is busy now, please try again later.	资源繁忙，可能由于指定资源正在被访问或回收。
403	OperationDenied_VersionUnsupported	The current instance version does not support this operation.Please upgrade the instance and try again.	当前实例版本不支持指定操作，请升级实例后再试。
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.VersionUnsupported	The current instance version does not support this operation.Please upgrade the instance and try again.	当前实例版本不支持指定操作，请升级实例后再试。
403	OperationDenied.TaskIsRunning	An operation is currently in progress. Try again later.	后台任务正在运行中，请稍后再试。
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	当前实例状态不允许执行该操作。
404	InvalidInstanceId_NotFound	The specified Instance ID does not exist.	实例不存在。
404	InvalidTopicName_NotFound	The specified topic does not exist.	Topic 不存在。
404	InvalidGroup_NotFound	The specified group does not exist.	Group 不存在。
404	InvalidAccessKeyId_NotFound	The specified accessKey does not exist.	AccessKey 不存在。
404	InvalidMessageId_NotFound	The message ID does not exist in the instance %s.	Message ID 不存在。
404	InvalidEip_NotFound	The specified EIP does not exist.	EIP 不存在。
404	InvalidGroup.NotFound	The specified group does not exist.	Group 不存在。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后再试。
500	ResourceIsBusy	The resource is busy now, please try again later.	资源繁忙，可能由于指定资源正在被访问或回收。
500	ServerInternalError	The request failed due to some unknown error, exception or failure.	服务内部错误。
503	ServiceUnavailable	The request failed due to a temporary failure of the server.	当前服务暂时不可用。

消息队列 RocketMQ版