文档

OnsTopicList - 获取Topic列表信息

更新时间:
一键部署

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

接口说明

注意 阿里云提供的 OpenAPI 属于管控类 API,用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成,消息收发的核心数据链路中严禁依赖 OpenAPI 实现,否则可能会导致链路产生风险。
本接口一般用于生成资源列表的场景,并不查看具体信息。

调试

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

授权信息

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

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

请求参数

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

查询指定 Topic 时设置,若不输入,则查询所有 Topic。

test
InstanceIdstring

需获取的 Topic 信息列表所对应的实例 ID。

MQ_INST_188077086902****_BXSuW61e
Tagobject []

Topic 所绑定的标签列表。列表元素个数不得超过 20。

Keystring

Topic 的标签键。KeyValue 值必须同时输入或同时不输入。若同时输入表示根据 Tag 过滤符合条件的 Topic,若不输入表示查询所有 Topic。

  • 如果输入该值,则取值不允许为空字符串。
  • 最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://
CartService
Valuestring

Topic 的标签值。KeyValue 值必须同时输入或同时不输入。若同时输入表示根据 Tag 过滤符合条件的 Topic,若不输入表示查询所有 Topic。

  • 如果输入该值,取值允许为空字符串。
  • 最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://
ServiceA
UserIdstring

Topic 资源创建者的用户 ID,即阿里云账号的 ID。

138015630679****

返回参数

名称类型描述示例值
object

返回的数据结构。

RequestIdstring

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

4A978869-7681-4529-B470-107E1379****
Dataobject []

返回指定实例的 Topic 信息列表。

MessageTypeinteger

消息类型。取值说明如下:

  • 0:普通消息
  • 1:分区顺序消息
  • 2:全局顺序消息
  • 4:事务消息
  • 5:定时/延时消息
0
RelationNamestring

所有关系名称,例如持有者、可订阅、可发布和可发布订阅。

授权发布/订阅
Ownerstring

Topic 所有者编号,为阿里云的账号 ID。

138015630679****
IndependentNamingboolean

Topic 所在实例是否有命名空间。取值说明如下:

  • true:拥有独立命名空间,资源命名确保实例内唯一,跨实例之间可重名。
  • false:无独立命名空间,实例内或者跨实例之间,资源命名必须全局唯一。
true
Remarkstring

备注信息。

测试
Relationinteger

所有关系编号。取值说明如下:

  • 1:持有者
  • 2:可以发布
  • 4:可以订阅
  • 6:可以发布和订阅
6
CreateTimelong

创建时间。

1570700947000
Topicstring

Topic 名称。

test
Tagsobject []

Topic 所绑定的标签。

Keystring

标签键。

CartService
Valuestring

标签值。

SrviceA
InstanceIdstring

Topic 所在的实例 ID。

MQ_INST_188077086902****_BXSuW61e
ServiceStatusinteger

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
      }
    ]
  }
}

错误码

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

  • 本页导读 (1)
文档反馈