ListConsumerGroupSubscriptions - 查询消费者组订阅关系列表_云消息队列 RocketMQ 版(RocketMQ)-阿里云帮助中心

查询指定消费者组的订阅关系。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
rocketmq:ListConsumerGroupSubscriptions	List	ConsumerGroup acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}	无	无

请求语法

GET /instances/{instanceId}/consumerGroups/{consumerGroupId}/subscriptions

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	云消息队列 RocketMQ 版的实例 ID。	rmq-cn-tl32wwz1r05
consumerGroupId	string	否	消费者分组 ID，表示需要查询哪个消费者分组的订阅关系。若不输入，则查询指定实例下所有的消费者分组的订阅关系。	PRINT_RETRY_CONSUMER

返回参数

名称	类型	描述	示例值
	object	Result<List>
requestId	string	请求 ID。	5F4D9D5F-625B-59FF-BD4F-DA8284575DB4
success	boolean	是否成功。	true
data	object []	返回结果。
consumerGroupId	string	消费者分组 ID。	CID-TEST
topicName	string	指定消费者分组订阅的主题。	topic_test
messageModel	string	消费者分组的消费模式。 BROADCASTING：广播模式 CLUSTERING：集群模式	CLUSTERING
subscriptionStatus	string	订阅状态。 ONLINE：在线。消费者分组下如果有多个消费者，只要有一个消费者在线则显订阅状态为在线。 OFFLINE：离线。消费者分组下如果有多个消费者，所有消费者都处于离线时订阅状态才显示离线。	ONLINE
filterExpression	string	过滤表达式。	*
filterExpressionType	string	过滤表达式类型。 SQL：SQL 过滤 TAG：Tag 过滤。	SQL
topicCreated	boolean	是否创建了 topic。	true
code	string	错误码。	MissingInstanceId
message	string	错误信息。	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	HTTP 状态码。	200
dynamicCode	string	动态错误码。	InstanceId
dynamicMessage	string	动态错误信息。	InstanceId

示例

正常返回示例

JSON格式

{
  "requestId": "5F4D9D5F-625B-59FF-BD4F-DA8284575DB4",
  "success": true,
  "data": [
    {
      "consumerGroupId": "CID-TEST",
      "topicName": "topic_test",
      "messageModel": "CLUSTERING",
      "subscriptionStatus": "ONLINE",
      "filterExpression": "*",
      "filterExpressionType": "SQL",
      "topicCreated": true
    }
  ],
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "InstanceId"
}

错误码

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