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

使用说明

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

QPS限制

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

授权信息

阿里云账号和RAM用户调用该接口,均不需要进行授权。但是RAM用户调用时仅返回对应有发布和订阅权限的资源数据,想要获取更多资源信息,需要通过阿里云账号给RAM用户授予相关资源的权限。更多信息,请参见权限策略和示例

调试

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

请求参数

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

系统规定参数。取值:OnsTopicList

Topic String test

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

InstanceId String MQ_INST_188077086902****_BXSuW61e

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

Tag.N.Key String CartService

Topic的标签键。

  • N的取值范围为1~20。
  • 若传入该值,则不允许为空字符串。
  • 最多支持128个字符,不能以aliyun和acs:开头,不能包含http://或者https://。
Tag.N.Value String ServiceA

Topic的标签值。

  • N的取值范围为1~20。
  • 若传入该值,可以为空字符串。
  • 最多支持128个字符,不能以aliyun和acs:开头,不能包含http://或者https://。

返回数据

名称 类型 示例值 描述
RequestId String 4A978869-7681-4529-B470-107E1379****

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

Data Array of PublishInfoDo

返回所有已发布的Topic信息列表。

PublishInfoDo
MessageType Integer 0

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

  • 0:普通消息
  • 1:分区顺序消息
  • 2:全局顺序消息
  • 4:事务消息
  • 5:定时/延时消息
RelationName String 授权发布/订阅

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

Owner String 138015630679****

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

IndependentNaming Boolean true

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

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

备注信息。

Relation Integer 6

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

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

创建时间。

Topic String test

Topic名称。

Tags Array of Tag

Topic所绑定的标签。

Tag
Key String CartService

标签键。

Value String SrviceA

标签值。

InstanceId String MQ_INST_188077086902****_BXSuW61e

Topic所在的实例ID。

示例

请求示例

http(s)://ons.cn-zhangjiakou.aliyuncs.com/?Action=OnsTopicList
&InstanceId=MQ_INST_188077086902****_BXSuW61e
&Tag.1.Key=CartService
&Tag.1.Value=ServiceA
&<公共请求参数>

正常返回示例

XML格式

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

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

JSON格式

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

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

错误码

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