ListConsumerGroups - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Queries the consumer groups in a specified instance.

Operation description

Note API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
rocketmq:ListConsumerGroups	list	ConsumerGroup acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/*	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The ID of the instance to which the consumer groups belong.	rmq-cn-7e22ody****
filter	string	No	The condition that you want to use to filter consumer groups in the instance. If you leave this parameter empty, all consumer groups in the instance are queried.	CID-TEST
pageNumber	integer	Yes	The number of the page to return.	1
pageSize	integer	Yes	The number of entries to return on each page.	10

Response parameters

Parameter	Type	Description	Example
	object	Result<MyPage>
requestId	string	The ID of the request. The system generates a unique ID for each request. You can troubleshoot issues based on the request ID.	5503A460-98ED-5543-92CF-4853DE28****
success	boolean	Indicates whether the call is successful.	true
data	object	The result data that is returned.
pageNumber	long	The page number of the returned page.	1
pageSize	long	The number of entries returned per page.	10
totalCount	long	The total number of returned entries.	1
list	array<object>	The paginated data.
list	object
regionId	string	The ID of the region in which the instance resides.	cn-hangzhou
instanceId	string	The ID of the instance.	rmq-cn-7e22ody****
consumerGroupId	string	The ID of the consumer group.	GID-TEST
status	string	The state of the consumer group. Valid values: RUNNING : The consumer group is running . CREATING : The consumer group is being created .	RUNNING
remark	string	The remarks on the consumer group.	This is the remark for test.
createTime	string	The time when the consumer group was created.	2022-08-01 20:05:50
updateTime	string	The time when the consumer group was last updated.	2022-08-01 20:05:50
code	string	The error code.	MissingInstanceId
message	string	The error message.	Parameter InstanceId is mandatory for this action .
httpStatusCode	integer	The HTTP status code.	400
dynamicCode	string	The dynamic error code.	InstanceId
dynamicMessage	string	The dynamic error message.	instanceId

Examples

Sample success responses

JSONformat

{
  "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"
      }
    ]
  },
  "code": "MissingInstanceId",
  "message": "Parameter InstanceId is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history