调用ListConsumerGroups查询指定实例的消费者分组列表-云消息队列 RocketMQ 版-阿里云

查询指定实例下消费者分组的列表信息。

接口说明

重要阿里云提供的 OpenAPI 属于管控类 API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖 OpenAPI 实现，否则可能会导致链路产生风险。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

rocketmq:ListConsumerGroups

list

*ConsumerGroup

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/*

无

请求语法

GET /instances/{instanceId}/consumerGroups HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
instanceId	string	是	指定需要获取哪个实例下的消费者分组列表。	rmq-cn-7e22ody****

请求参数

名称	类型	必填	描述	示例值
filter	string	否	查询的过滤条件，若不输入则查询指定实例下所有的消费者分组。	CID-TEST
pageNumber	integer	否	分页页码，查询第几页的返回结果。	1
pageSize	integer	否	分页大小，每页最多显示的返回结果数量。取值范围：[10,100]。	10

返回参数

名称	类型	描述	示例值
	object	Result<MyPage>
requestId	string	请求 ID，每个请求的 ID 都是唯一的，可用于排查和定位问题。	5503A460-98ED-5543-92CF-4853DE28****
success	boolean	执行结果是否成功。	true
data	object	返回结果。
pageNumber	integer	当前页码。	1
pageSize	integer	分页大小。	10
totalCount	integer	返回结果的总数量。	1
list	array<object>	分页数据。
	object
regionId	string	实例所属的地域 ID。	cn-hangzhou
instanceId	string	实例 ID。	rmq-cn-7e22ody****
consumerGroupId	string	消费者分组 ID。	GID-TEST
status	string	消费者分组的状态。枚举值： RUNNING : 运行中 CREATING : 创建中	RUNNING
remark	string	消费者分组的备注信息。	This is the remark for test.
createTime	string	消费者分组的创建时间。	2022-08-01 20:05:50
updateTime	string	消费者分组的最后更新时间。	2022-08-01 20:05:50
maxReceiveTps	integer	消费消息 tps 上限	1000
messageModel	string	消费模式	LITE_SELECTIVE
topicName	string	lite 类型的 topicName	test1
code	string	错误码。	MissingInstanceId
message	string	错误信息。	Parameter InstanceId is mandatory for this action .
httpStatusCode	integer	HTTP 状态码。	400
dynamicCode	string	动态错误码。	InstanceId
dynamicMessage	string	动态错误信息。	instanceId

示例

正常返回示例

JSON格式

{
  "requestId": "5503A460-98ED-5543-92CF-4853DE28****",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 1,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "consumerGroupId": "GID-TEST",
        "status": "RUNNING",
        "remark": "This is the remark for test.",
        "createTime": "2022-08-01 20:05:50",
        "updateTime": "2022-08-01 20:05:50",
        "maxReceiveTps": 1000,
        "messageModel": "LITE_SELECTIVE",
        "topicName": "test1"
      }
    ]
  },
  "code": "MissingInstanceId",
  "message": "Parameter InstanceId is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。