ListConsumerGroupSubscriptions - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Lists the subscription relationships for a consumer group.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

rocketmq:ListConsumerGroupSubscriptions

list

*ConsumerGroup

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

None

Request syntax

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

Path 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 subscription relationships you want to query.	PRINT_RETRY_CONSUMER

Request parameters

Parameter	Type	Required	Description	Example
topicName	string	No	The name of the topic. If you do not specify this parameter, all subscription relationships are queried.	topic_test

Response elements

Element	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 data returned.
	object	The list of subscription relationships for 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. BROADCASTING: The broadcast consumption mode. CLUSTERING: The cluster consumption mode.	CLUSTERING
subscriptionStatus	string	The subscription status. ONLINE: The consumer group is online. If a consumer group contains multiple consumers, the group is considered online as long as at least one consumer is online. OFFLINE: The consumer group is offline. If a consumer group contains multiple consumers, the group is considered offline only when all consumers are offline.	ONLINE
filterExpression	string	The filter expression.	*
filterExpressionType	string	The type of the filter expression. SQL: SQL filtering. TAG: Tag filtering.	SQL
topicCreated	boolean	Indicates whether the topic is created.	true
consistency	boolean	The consistency of the subscription relationship. false: The subscription relationship is inconsistent. true: The subscription relationship is consistent.	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

Success response

JSON format

{
  "requestId": "5F4D9D5F-625B-59FF-BD4F-DA8284575DB4",
  "success": true,
  "data": [
    {
      "consumerGroupId": "CID-TEST",
      "topicName": "topic_test",
      "messageModel": "CLUSTERING",
      "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.