全部产品
Search

搜索本产品

    云消息队列 RocketMQ 版：ListConsumerGroupSubscriptions - 查询消费者组订阅关系列表

    文档中心

    云消息队列 RocketMQ 版：ListConsumerGroupSubscriptions - 查询消费者组订阅关系列表

    更新时间：Sep 24, 2024

    查询消费组订阅关系列表。

    调试

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

    授权信息

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

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

    请求语法

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

    请求参数

    名称类型必填描述示例值
    instanceIdstring是

    云消息队列 RocketMQ 版的实例 ID。

    		rmq-cn-tl32wwz1r05
    consumerGroupIdstring是

    消费者分组 ID，表示需要查询哪个消费者分组的订阅关系。

    		PRINT_RETRY_CONSUMER

    返回参数

    名称类型描述示例值
    object

    Result<List>

    requestIdstring

    请求 ID。

    		5F4D9D5F-625B-59FF-BD4F-DA8284575DB4
    successboolean

    是否成功。

    		true
    dataarray<object>

    返回结果。

    dataobject

    消费者组订阅关系列表。

    consumerGroupIdstring

    消费者分组 ID。

    		CID-TEST
    topicNamestring

    指定消费者分组订阅的主题。

    		topic_test
    messageModelstring

    消费者分组的消费模式。

    • BROADCASTING：广播模式
    • CLUSTERING：集群模式
    		CLUSTERING
    subscriptionStatusstring

    订阅状态。

    • ONLINE：在线。消费者分组下如果有多个消费者，只要有一个消费者在线则显订阅状态为在线。
    • OFFLINE：离线。消费者分组下如果有多个消费者，所有消费者都处于离线时订阅状态才显示离线。
    		ONLINE
    filterExpressionstring

    过滤表达式。

    		*
    filterExpressionTypestring

    过滤表达式类型。

    • SQL：SQL 过滤
    • TAG：Tag 过滤。
    		SQL
    topicCreatedboolean

    是否创建了 topic。

    		true
    consistencyboolean

    消息消费的一致性。

    • 消费组存在未消费的消息为 false。
    • 消费组不存在未消费的消息为 true。
    		true
    codestring

    错误码。

    		MissingInstanceId
    messagestring

    错误信息。

    		Parameter instanceId is mandatory for this action .
    httpStatusCodeinteger

    HTTP 状态码。

    		200
    dynamicCodestring

    动态错误码。

    		InstanceId
    dynamicMessagestring

    动态错误信息。

    		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,
      "consistency": true
    }
  ],
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "InstanceId"
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-09-09API 内部配置变更，不影响调用查看变更详情
    2024-05-28OpenAPI 返回结构发生变更查看变更详情