调用OnsTopicSubDetail查看有哪些在线订阅组订阅了这个Topic。

使用说明

该接口用于查询Group和Topic之间的订阅关系。如果Group ID对应的消费者实例不在线则查不到数据。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

授权信息

默认仅限阿里云账号使用本接口，RAM用户只有在被授予了相关API操作权限后方可使用。本接口的授权信息如下表所示。更多信息，请参见权限策略和示例。

API

Action

Resource（有命名空间）

Resource（无命名空间）

OnsTopicSubDetail

mq:QueryInstanceBaseInfo

mq:QueryTopicSubDetail

acs:mq:*:*:{instanceId}%{topic}

acs:mq:*:*:{topic}

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 OnsTopicSubDetail

系统规定参数。取值：OnsTopicSubDetail。

InstanceId String 是 MQ_INST_111111111111_DOxxxxxx

需查询的Topic所对应的实例ID。
Topic String 是 test

需查询的Topic。

返回数据

名称 类型 示例值 描述
RequestId String 87B6207F-2908-42B5-A134-84956DCA****

公共参数，每个请求的ID都是唯一的，可用于排查和定位问题。
Data Object

返回Data对象。
SubscriptionDataList Array of SubscriptionDataList

所有在线订阅组。
SubscriptionDataList
GroupId String GID_test

订阅该Topic的Group ID。
MessageModel String CLUSTERING

消费模式。取值说明如下：

  • CLUSTERING：集群订阅
  • BROADCASTING：广播订阅

消费模式的更多信息，请参见集群消费和广播消费。

SubString String *

订阅表达式。
Topic String test

Topic名称。

示例

请求示例

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsTopicSubDetail
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&Topic=test
&<公共请求参数>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<OnsTopicSubDetailResponse>
<Data>
    <Topic>test</Topic>
    <SubscriptionDataList>
        <SubscriptionDataList>
            <SubString>*</SubString>
            <MessageModel>CLUSTERING</MessageModel>
            <GroupId>GID_test</GroupId>
        </SubscriptionDataList>
    </SubscriptionDataList>
</Data>
<RequestId>87B6207F-2908-42B5-A134-84956DCA****</RequestId>
</OnsTopicSubDetailResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Data" : {
    "Topic" : "test",
    "SubscriptionDataList" : {
      "SubscriptionDataList" : [ {
        "SubString" : "*",
        "MessageModel" : "CLUSTERING",
        "GroupId" : "GID_test"
      } ]
    }
  },
  "RequestId" : "87B6207F-2908-42B5-A134-84956DCA****"
}

错误码

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

控制台操作

除了调用OnsTopicSubDetail接口，您还可以通过消息队列RocketMQ版控制台查看Topic和Group的订阅关系。具体操作，请参见查看订阅关系。