ListConsumerGroupSubscriptions - - Alibaba Cloud Documentation Center

Queries the subscriptions of a consumer group.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:ListConsumerGroupSubscriptions	list	*ConsumerGroup `acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}`	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The ID of the ApsaraMQ for RocketMQ instance.	rmq-cn-tl32wwz1r05
consumerGroupId	string	Yes	The ID of the consumer group whose subscriptions you want to query. If you do not configure this parameter, the subscriptions of all consumer groups on the specified instance are queried.	PRINT_RETRY_CONSUMER

Response parameters

Parameter	Type	Description	Example
	object	Result<List>
requestId	string	The request ID.	5F4D9D5F-625B-59FF-BD4F-DA8284575DB4
success	boolean	Indicates whether the request was successful.	true
data	array<object>	The returned data.
data	object	The subscriptions of the consumer group.
consumerGroupId	string	The ID of the consumer group.	CID-TEST
topicName	string	The topic to which the consumer group subscribes.	topic_test
messageModel	string	The consumption mode of the consumer group. Valid values: BROADCASTING: broadcasting consumption CLUSTERING: clustering consumption	BROADCASTING
subscriptionStatus	string	The subscription status. Valid values: ONLINE: The consumer group is online. If the consumer group contains multiple consumers, this value is returned as long as one of the consumers is online. OFFLINE: The consumer group is offline. If the consumer group contains multiple consumers, this value is returned only if all consumers are offline.	ONLINE
filterExpression	string	The filter expression.	*
filterExpressionType	string	The type of the filter expression. Valid values: SQL: filters messages by using SQL expressions. TAG: filters messages by using tags.	SQL
topicCreated	boolean	Indicates whether the topic is created.	true
consistency	boolean	Indicates whether message consumption is consistent. Valid values: false: Unconsumed messages exist in the consumer group. true: No unconsumed message exists in the consumer group.	true
code	string	The error code.	MissingInstanceId
message	string	The error message.	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	The HTTP status code.	200
dynamicCode	string	The dynamic error code.	InstanceId
dynamicMessage	string	The dynamic error message.	InstanceId

Examples

Sample success responses

JSONformat

{
  "requestId": "5F4D9D5F-625B-59FF-BD4F-DA8284575DB4",
  "success": true,
  "data": [
    {
      "consumerGroupId": "CID-TEST",
      "topicName": "topic_test",
      "messageModel": "BROADCASTING",
      "subscriptionStatus": "ONLINE",
      "filterExpression": "*",
      "filterExpressionType": "SQL",
      "topicCreated": true,
      "consistency": true
    }
  ],
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "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
2024-09-09	The internal configuration of the API is changed, but the call is not affected	View Change Details
2024-05-28	The response structure of the API has changed	View Change Details