调用 DescribeGroups 接口查看指定实例的 Group 列表。

使用说明

此接口用于获取指定实例的消费组列表，支持根据消费组 ID 和状态进行筛选。

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：DescribeGroups

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

Version string 必选示例值：2022-05-01

API的版本，取值：2022-05-01。

State string 可选示例值：Stable

状态查询字段，默认不查询，字符串匹配过滤

SortOrder string 可选示例值：Asc

排序方式，Desc：降序；Asc：升序；缺省：Asc。

PageNumber integer 必选示例值：1

列表的页码，最小值为 1。

PageSize integer 必选示例值：10

列表中每一页的条目数量，取值范围为 1~100。

InstanceId string 必选示例值：kafka-cnngbnnts****

实例 ID。

GroupId string 可选示例值：Group1

根据 Group ID 筛选。

TagFilters object[] 可选示例值：--

用于筛选 Group 的标签。

标签键（Key）和标签值（Value）均必填。Value 可传空字符串，传空时只根据 Key 筛选 Group。

设置多个标签时，不同筛选条件之间为或关系，即满足任一标签筛选条件则匹配成功。

Key string 必选示例值：test-Key

标签的键。

Value string 必选示例值：test-value

标签的值。

Topic string 可选示例值：Topic1

根据 Topic 名称筛选。

SortBy string 可选示例值：GroupId

排序字段，支持 GroupId，或者 State，缺省为 GroupId。

返回参数

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

Total integer 示例值：10

符合筛选条件的 Group 总数。

GroupsInfo object[] 示例值：--

Group 列表。

GroupId string 示例值：testgroup

Group 的 ID。

State string 示例值：Empty

消费组状态。

PreparingRebalance：消费准备

CompletingRebalance：分配分区中

Stable：消费中

Empty：未消费

Dead：已失效

Description string 示例值：new

消费组描述信息。

ProtocolType string 示例值：consumer

消费组指定的消费协议类型。

如果使用标准 Kafka 的消费协议，则显示为 consumer。

如果使用其他协议类型，则显示对应协议名称，例如 Kafka-Connector 接入时显示为 connect 类型。

若使用自定义分区的消费方式，该字段可能为空。

BalanceAlgorithm string 示例值：range

将消费的分区分配给消费者使用的算法，由消费客户端指定，若使用自定义分区的消费方式，该字段可能为空。

Tags object[] 示例值：--

Group 的标签。

Key string 示例值：test-Key

标签的键。

Value string 示例值：test-value

标签的值。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter is not valid.	参数值无效。
400	InvalidParameter.instance.id:{}	The instance ID is not available	实例 ID 不可用。
400	InvalidParameter.SortOrder	The specified parameter SortOrder is not valid.	输入的参数 SortOrder 非法。
400	InvalidParameter.instance.id:kafka-cnoeas11o4gl7v9r	The specified parameter instance_id:kafka-cnoeas11o4gl7v9r is not valid.	输入的参数实例 ID 非法。
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	您不具备相关权限，请授权或切换账号后重试。
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	当前实例状态不允许执行该操作。
404	InvalidGroupId.NotFound	The specified consumer 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.	内部错误，请稍后重试。

消息队列 Kafka版