使用ListConsumerConnections获取消费者客户端连接信息-云消息队列 RocketMQ 版-阿里云

获取指定消费者客户端的连接信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

rocketmq:ListConsumerConnections

list

*ConsumerGroup

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

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 ID。	rmq-cn-uax32mf9h1f
consumerGroupId	string	是	消费者分组 ID。	GID_TEST_STOCK_OPEND_GW

请求参数

名称	类型	必填	描述	示例值
topicName	string	否	lite 类型的 topic 名称	test1
liteTopicName	string	否	Lite 消息队列主题名称	abc

返回参数

名称	类型	描述	示例值
	object	Result
requestId	string	请求 ID	A3620115-6F1F-5CFB-AA3F-BBD4853B2EC4
success	boolean	是否成功	true
data	object	返回结果
regionId	string	区域 ID	cn-hangzhou
instanceId	string	实例 ID	rmq-cn-7e22ody****
consumerGroupId	string	消费者组 ID	CID-TEST
connections	array<object>	客户端连接列表
	object	客户端连接列表。
clientId	string	客户端 ID	172.17.135.197@17392#1936705963#551717232#9873695589062458
hostname	string	客户端 IP	vos
egressIp	string	宿主机 IP/公网出网 IP	xx.xx.xx.xx
language	string	客户端语言	java
version	string	客户端版本	1.0
messageModel	string	消费者对消息的消费模式： CLUSTERING LITE_SELECTIVE BROADCASTING	BROADCASTING
code	string	错误码	MissingPageNumber
message	string	错误信息	The instance cannot be found.
httpStatusCode	integer	HTTP 状态码	200
dynamicCode	string	动态错误码	InstanceId
dynamicMessage	string	动态错误信息	instanceId

示例

正常返回示例

JSON格式

{
  "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"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。