OnsTopicSubDetail - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Queries the online consumer groups that subscribe to a specified topic.

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.

You can call this operation to query the online consumer groups that subscribe to a specified topic. If all consumers in a group are offline, the information about the group is not returned.

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
mq:QueryTopicSubDetail	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance that contains the topic you want to query.	MQ_INST_111111111111_DOxxxxxx
Topic	string	Yes	The name of the topic that you want to query.	test

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	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.	87B6207F-2908-42B5-A134-84956DCA****
Data	object	The data returned.
SubscriptionDataList	object []	The information about the online consumer groups that subscribe to the topic.
GroupId	string	The ID of the consumer group that subscribes to the topic.	GID_test
MessageModel	string	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.	CLUSTERING
SubString	string	The expression based on which consumers in the consumer group subscribe to the topic.	*
Topic	string	The topic name.	test

Examples

Sample success responses

JSONformat

{
  "RequestId": "87B6207F-2908-42B5-A134-84956DCA****",
  "Data": {
    "SubscriptionDataList": {
      "SubscriptionDataList": [
        {
          "GroupId": "GID_test",
          "MessageModel": "CLUSTERING",
          "SubString": "*"
        }
      ]
    },
    "Topic": "test"
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history

You can also view the information about the online consumer groups that subscribe to a topic in the ApsaraMQ for RocketMQ console. For more information, see View subscriptions.