GetConsumerGroupSubscription - - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

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

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	rmq-cn-uqm32kqyy11
consumerGroupId	string	Yes	The ID of the consumer group whose subscriptions you want to query.	common_dev
topicName	string	Yes	The name of the topic to which the consumer group subscribes.	mq003

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	The request ID.	157DF7D4-53FB-58C6-BEBC-A9400E7EF68A
success	boolean	Indicates whether the request was successful.	true
data	array<object>	The data returned.
data	object	The subscriptions.
subscriptionDTO	object	The subscription details.
consumerGroupId	string	The consumer group ID.	GID_inspector_group
topicName	string	The topic to which the consumer group subscribes.	Topic_normal_inspector
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 if at least 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.	UNSPECIFIED
connectionDTO	object	The connection details.
clientId	string	The client ID.	192.168.50.191@19908#-2093249153#1534215565#40385215750900
hostname	string	The host name.	nginx
egressIp	string	The public IP address of the host.	xx.xx.xx.xx
language	string	The language used by the client.	zh
version	string	The client version.	1.0.0
messageModel	string	The consumption mode of the consumer group. Valid values: BROADCASTING: broadcasting consumption CLUSTERING: clustering consumption	BROADCASTING
code	string	The error code.	Instance.NotFound
message	string	The error message.	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	The response code.	200
dynamicCode	string	The dynamic error code.	InstanceId
dynamicMessage	string	The dynamic error message.	instanceId

Examples

Sample success responses

JSONformat

{
  "requestId": "157DF7D4-53FB-58C6-BEBC-A9400E7EF68A",
  "success": true,
  "data": [
    {
      "subscriptionDTO": {
        "consumerGroupId": "GID_inspector_group",
        "topicName": "Topic_normal_inspector",
        "messageModel": "BROADCASTING",
        "subscriptionStatus": "ONLINE",
        "filterExpression": "*",
        "filterExpressionType": "UNSPECIFIED"
      },
      "connectionDTO": {
        "clientId": "192.168.50.191@19908#-2093249153#1534215565#40385215750900",
        "hostname": "nginx",
        "egressIp": "xx.xx.xx.xx",
        "language": "zh",
        "version": "1.0.0",
        "messageModel": "BROADCASTING"
      }
    }
  ],
  "code": "Instance.NotFound",
  "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.