使用OnsTopicList获取Topic列表信息-云消息队列 RocketMQ 版-阿里云-云消息队列 RocketMQ 版(RocketMQ)-阿里云帮助中心

查询账号下所有Topic的信息列表。

接口说明

重要阿里云提供的 OpenAPI 属于管控类 API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖 OpenAPI 实现，否则可能会导致链路产生风险。

本接口一般用于生成资源列表的场景，并不查看具体信息。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

mq:ListTopic

list

Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

无

mq:QueryInstanceBaseInfo

请求参数

名称	类型	必填	描述	示例值
Topic	string	否	查询指定 Topic 时设置，若不输入，则查询所有 Topic。	test
InstanceId	string	否	需获取的 Topic 信息列表所对应的实例 ID。	MQ_INST_188077086902****_BXSuW61e
Tag	array<object>	否	Topic 所绑定的标签列表。列表元素个数不得超过 20。
	object	否	返回的标签结构。
Key	string	是	Topic 的标签键。Key 和 Value 值必须同时输入或同时不输入。若同时输入表示根据 Tag 过滤符合条件的 Topic，若不输入表示查询所有 Topic。如果输入该值，则取值不允许为空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	CartService
Value	string	是	Topic 的标签值。Key 和 Value 值必须同时输入或同时不输入。若同时输入表示根据 Tag 过滤符合条件的 Topic，若不输入表示查询所有 Topic。如果输入该值，取值允许为空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	ServiceA
UserId	string	否	Topic 资源创建者的用户 ID，即阿里云账号的 ID。	138015630679****

返回参数

名称	类型	描述	示例值
	object	返回的数据结构。
RequestId	string	公共参数，每个请求 ID 都是唯一的，可用于排查和定位问题。	4A978869-7681-4529-B470-107E1379****
Data	object
PublishInfoDo	array<object>	返回指定实例的 Topic 信息列表。
	array<object>	返回的 Topic 的数据结构。
MessageType	integer	消息类型。取值说明如下： 0：普通消息 1：分区顺序消息 2：全局顺序消息 4：事务消息 5：定时/延时消息	0
RelationName	string	所有关系名称，例如持有者、可订阅、可发布和可发布订阅。	授权发布/订阅
Owner	string	Topic 所有者编号，为阿里云的账号 ID。	138015630679****
IndependentNaming	boolean	Topic 所在实例是否有命名空间。取值说明如下： true：拥有独立命名空间，资源命名确保实例内唯一，跨实例之间可重名。 false：无独立命名空间，实例内或者跨实例之间，资源命名必须全局唯一。	true
Remark	string	备注信息。	测试
Relation	integer	所有关系编号。取值说明如下： 1：持有者 2：可以发布 4：可以订阅 6：可以发布和订阅	6
CreateTime	integer	创建时间。	1570700947000
Topic	string	Topic 名称。	test
Tags	object
Tag	array<object>	Topic 所绑定的标签。
	object	标签结构定义。
Key	string	标签键。	CartService
Value	string	标签值。	SrviceA
InstanceId	string	Topic 所在的实例 ID。	MQ_INST_188077086902****_BXSuW61e
ServiceStatus	integer	Topic 异步创建的状态。取值说明如下： 0：创建中。 1：服务中。	0

示例

正常返回示例

JSON格式

{
  "RequestId": "4A978869-7681-4529-B470-107E1379****",
  "Data": {
    "PublishInfoDo": [
      {
        "MessageType": 0,
        "RelationName": "授权发布/订阅",
        "Owner": "138015630679****",
        "IndependentNaming": true,
        "Remark": "测试",
        "Relation": 6,
        "CreateTime": 1570700947000,
        "Topic": "test",
        "Tags": {
          "Tag": [
            {
              "Key": "CartService",
              "Value": "SrviceA"
            }
          ]
        },
        "InstanceId": "MQ_INST_188077086902****_BXSuW61e",
        "ServiceStatus": 0
      }
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。