全部产品
Search
文档中心

云消息队列 RocketMQ 版:GetConsumerGroupSubscription - 获取消费者组订阅关系详情

更新时间:Sep 24, 2024

获取消费组订阅关系详情,包括客户端分布等信息。

调试

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

授权信息

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

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

请求语法

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

请求参数

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

实例 ID。

rmq-cn-uqm32kqyy11
consumerGroupIdstring

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

common_dev
topicNamestring

消费者分组订阅的主题名称。

mq003

返回参数

名称类型描述示例值
object

Result<List>

requestIdstring

请求 ID

157DF7D4-53FB-58C6-BEBC-A9400E7EF68A
successboolean

是否成功

true
dataarray<object>

返回结果

dataobject

订阅信息列表

subscriptionDTOobject

订阅信息

consumerGroupIdstring

消费者组

GID_inspector_group
topicNamestring

订阅主题

Topic_normal_inspector
messageModelstring

消费者分组的消费模式。

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

订阅状态。

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

过滤表达式

*
filterExpressionTypestring

过滤表达式类型。

  • SQL:SQL 过滤
  • TAG:Tag 过滤。
UNSPECIFIED
connectionDTOobject

连接详情信息

clientIdstring

客户端 ID

192.168.50.191@19908#-2093249153#1534215565#40385215750900
hostnamestring

主机名

nginx
egressIpstring

宿主机 IP/公网出网 IP

xx.xx.xx.xx
languagestring

客户端语言

zh
versionstring

客户端版本

1.0.0
messageModelstring

消费者分组的消费模式。

  • BROADCASTING:广播模式
  • CLUSTERING:集群模式
BROADCASTING
codestring

错误码

Instance.NotFound
messagestring

错误信息

Parameter instanceId is mandatory for this action .
httpStatusCodeinteger

HTTP 状态码

200
dynamicCodestring

动态错误码

InstanceId
dynamicMessagestring

动态错误信息

instanceId

示例

正常返回示例

JSON格式

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

错误码

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