ListConsumerConnections - - Alibaba Cloud Documentation Center

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

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	rmq-cn-uax32mf9h1f
consumerGroupId	string	Yes	The consumer group ID.	GID_TEST_STOCK_OPEND_GW

Response parameters

Parameter	Type	Description	Example
	object	Result
requestId	string	The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.	A3620115-6F1F-5CFB-AA3F-BBD4853B2EC4
success	boolean	Indicates whether the call was successful.	true
data	object	The returned data.
regionId	string	The ID of the region in which the instance resides.	cn-hangzhou
instanceId	string	The instance ID.	rmq-cn-7e22ody****
consumerGroupId	string	The consumer group ID.	CID-TEST
connections	array<object>	The client connection list
connection	object
clientId	string	The ID of the client.	172.17.135.197@17392#1936705963#551717232#9873695589062458
hostname	string	The `hostname` of the cloud-native box.	vos
egressIp	string	Host IP/Public IP	xx.xx.xx.xx
language	string	The language of the client.	java
version	string	The version of the client.	1.0
messageModel	string	Consumption Mode BROADCASTING CLUSTERING	BROADCASTING
code	string	The returned error code.	MissingPageNumber
message	string	The error message.	The instance cannot be found.
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": "A3620115-6F1F-5CFB-AA3F-BBD4853B2EC4",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "consumerGroupId": "CID-TEST",
    "connections": [
      {
        "clientId": "172.17.135.197@17392#1936705963#551717232#9873695589062458",
        "hostname": "vos",
        "egressIp": "xx.xx.xx.xx",
        "language": "java",
        "version": "1.0",
        "messageModel": "BROADCASTING"
      }
    ]
  },
  "code": "MissingPageNumber",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Error codes

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