文档中心

消息队列 RocketMQ版

Group管理

DescribeGroups - 获取实例 Group 列表

调用 DescribeGroups 接口查看 Group 列表。

使用说明

DescribeGroups 接口用于查看指定实例下的 Group 列表，其中包含每个 Group 的详细信息。如果只需查看指定 Group 的详细信息，推荐使用 DescribeGroupsDetail 接口。

注意事项

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

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：DescribeGroups

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

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

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

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

实例 ID。

PageNumber integer 必选示例值：1

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

PageSize integer 必选示例值：10

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

GroupId string 可选示例值：GID_test

根据 Group 的 ID 筛选。支持模糊查询。

不指定此参数时，表示查询所有 Group。

GroupType string 可选示例值：TCP

按 Group 适用的协议进行筛选过滤。

支持设置为TCP（默认值），此 Group 仅适用于 TCP 协议的消息收发。

返回参数

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

Total integer 示例值：1

Group 总数。

GroupsInfo object[] 示例值：[ { "Description": "", "GroupId": "GID_test", "GroupType": "TCP" } ]

查询消费组的结果列表。

GroupId string 示例值：GID_test_group_id

消费组的 Group ID。

GroupType string 示例值：TCP

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

TCP：此 Group 仅适用于 TCP 协议的消息收发。

Description string 示例值：test

Group 的简单描述。

请求示例

POST /?Action=DescribeGroups&Version=2023-01-01 HTTP/1.1​
Host:  rocketmq.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260112T070721Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260112/cn-beijing/RocketMQ/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
  "InstanceId": "rocketmq-cnai1f0c29ca****",​
  "PageNumber": 1,​
  "PageSize": 10​
}​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "2026011215072606113900009469****",​
    "Action": "DescribeGroups",​
    "Version": "2023-01-01",​
    "Service": "RocketMQ",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "Total": 1,​
    "GroupsInfo": [​
      {​
        "GroupId": "GID_test_group_id",​
        "GroupType": "TCP",​
        "Description": "test"​
      }​
    ]​
  }​
}​

错误码

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

状态码	错误码	错误信息	说明
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	InvalidPara	The specified parameter is not valid.	参数值无效。
400	OperationDenied.InvalidRequest	The request that you specified 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	InvalidGroup.NotFound	The specified group does not exist.	Group 不存在。
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.	当前服务暂时不可用。

最近更新时间：2026.02.13 18:31:52

这个页面对您有帮助吗？

有用

无用