查询指定实例下 Topic 的信息列表。

调试

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

请求参数

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

系统规定参数。取值：ListMqSofamqTopic。
InstanceId String 是 000001

需获取的 Topic 信息列表所对应的实例 ID
PageNum Long 是 1

页码
PageSize Long 是 10

每页显示条数
Topic String 否 TP_TEST

查询指定 Topic 时设置，否则查询所有 Topic

返回数据

名称 类型 示例值 描述
Data Struct

返回所有查询到的 Topic 信息列表
Content Array

Topic 信息
Cluster String single

集群名称
GmtCreate Long 1570966857000

创建时间
GmtModified Long 1570966857000

修改时间
Id Long 1

数据库 ID
InstanceId String 000001

实例 ID
MessageType Long 0

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

0：普通消息

1：分区顺序消息

2：全局顺序消息

4：事务消息

5：定时/延时消息
Operator String alipay

创建人
Perm Long 6

设置该 Topic 的读写模式。取值说明如下：

6：同时支持读写

4：禁写

2：禁读
ReadQueueNum Long 8

读分区数
Remark String desc

Topic 备注信息
Topic String TP_TEST

Topic 名称
WriteQueueNum Long 8

写分区数
PageNum Long 1

页码
PageSize Long 10

每页显示条数
Total Long 100

总条数
RequestId String 861E6630-AEC0-4B2D-B214-6CB5E44B7F04

请求ID
ResultCode String OK

结果码
ResultMessage String OK

结果描述

示例

请求示例

http(s)://[Endpoint]/?Action=ListMqSofamqTopic
&InstanceId=000001
&PageNum=1
&PageSize=10
&<公共请求参数>

正常返回示例

XML 格式 

<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>
<Data>
    <PageNum>1</PageNum>
    <PageSize>10</PageSize>
    <Content>
        <Operator>alipay</Operator>
        <GmtCreate>1570966857000</GmtCreate>
        <InstanceId>000001</InstanceId>
        <Perm>6</Perm>
        <GmtModified>1570966857000</GmtModified>
        <Cluster>single</Cluster>
        <ReadQueueNum/>
        <Id>1</Id>
        <Topic>TP_TEST</Topic>
        <WriteQueueNum>8</WriteQueueNum>
        <MessageType>0</MessageType>
        <Remark>desc</Remark>
    </Content>
    <Total>100</Total>
</Data>
<ResultMessage>OK</ResultMessage>
<ResultCode>OK</ResultCode>

JSON 格式 

{"RequestId":"861E6630-AEC0-4B2D-B214-6CB5E44B7F04","Data":{"PageNum":"1","PageSize":"10","Content":[{"Operator":"alipay","GmtCreate":"1570966857000","InstanceId":"000001","Perm":"6","GmtModified":"1570966857000","Cluster":"single","ReadQueueNum":"","Id":"1","Topic":"TP_TEST","WriteQueueNum":"8","MessageType":"0","Remark":"desc"}],"Total":"100"},"ResultMessage":"OK","ResultCode":"OK"}

错误码

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