All Products
Document Center

ApsaraMQ for RocketMQ:OnsGroupSubDetail

Last Updated:Mar 03, 2024

Queries all topics to which a specified consumer group subscribes. If no consumer instance in the consumer group is online, no data is returned.

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.


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

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.
OperationAccess levelResource typeCondition keyAssociated operation
  • All Resources

Request parameters


The ID of the instance to which the consumer group you want to query belongs.


The ID of the consumer group that you want to query.


Response parameters


The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.


The data returned.

SubscriptionDataListobject []

The topics to which consumers in the consumer group subscribe. If all consumers in the specified group are offline, no topics are returned.


The expression based on which consumers in the consumer group subscribe to the topic.


The name of the topic to which consumers in the consumer group subscribe.


The ID of the consumer group that you want to query.


The consumption mode. Valid values:

  • CLUSTERING: the clustering consumption mode
  • BROADCASTING: the broadcasting consumption mode

For more information about consumption modes, see Clustering consumption and broadcasting consumption.


Indicates whether consumers in the group are online.



Sample success responses


  "RequestId": "3364E875-013B-442A-BC3C-C1A84DC6****",
  "Data": {
    "SubscriptionDataList": {
      "SubscriptionDataList": [
          "SubString": "*",
          "Topic": "test-mq_topic"
    "GroupId": "GID_test_group_id",
    "MessageModel": "CLUSTERING",
    "Online": true

Error codes

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

Change history

Change timeSummary of changesOperation
No change history

Query the topics to which a consumer group subscribe in the console

You can also query the topics to which a consumer group subscribe in the ApsaraMQ for RocketMQ console.**** For more information, see Query subscriptions.