全部产品
Search
文档中心

云消息队列 RocketMQ 版:OnsTopicSubDetail - 查看Topic的订阅信息

更新时间:Mar 03, 2024

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

接口说明

注意 阿里云提供的 OpenAPI 属于管控类 API,用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成,消息收发的核心数据链路中严禁依赖 OpenAPI 实现,否则可能会导致链路产生风险。
该接口用于查询 Group 和 Topic 之间的订阅关系。如果 Group ID 对应的消费者实例不在线则查不到数据。

调试

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

授权信息

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

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

请求参数

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

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

MQ_INST_111111111111_DOxxxxxx
Topicstring

需查询的 Topic。

test

返回参数

名称类型描述示例值
object
RequestIdstring

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

87B6207F-2908-42B5-A134-84956DCA****
Dataobject

返回 Data 对象。

SubscriptionDataListobject []

所有在线订阅组。

GroupIdstring

订阅该 Topic 的 Group ID。

GID_test
MessageModelstring

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

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

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

CLUSTERING
SubStringstring

订阅表达式。

*
Topicstring

Topic 名称。

test

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史

控制台操作

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