查詢指定實例下 Topic 的信息列表。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 ListMqSofamqTopic

系統規定參數。取值：ListMqSofamqTopic。
InstanceId String 是 000001

需獲取的 Topic 信息列表所對應的實例 ID
PageNum Long 是 1

頁碼，默認值：1
PageSize Long 是 10

每頁顯示條數，默認值：10
Topic String 否 TP_TEST

查詢指定 Topic 時設置，否則查詢所有 Topic

返回數據

名稱 類型 示例值 描述
ResultMessage String OK

結果描述
ResultCode String OK

結果碼
RequestId String 861E6630-AEC0-4B2D-B214-6CB5E44B7F04

請求 ID
Data Object

返回所有查詢到的 Topic 信息列表
PageNum Long 1

頁碼，默認值：1
PageSize Long 10

每頁顯示條數，默認值：10
Total Long 100

總條數
Content Array of Content

Topic 信息
Cluster String single

集群名稱
Remark String desc

Topic 備注信息
WriteQueueNum Long 8

寫分區數
ReadQueueNum Long 8

讀分區數
InstanceId String 000001

實例 ID
GmtModified Long 1570966857000

修改時間
MessageType Long 0

消息類型。取值說明如下：

  • 0：普通消息
  • 1：分區順序消息
  • 2：全局順序消息
  • 4：事務消息
  • 5：定時/延時消息
Perm Long 6

設置該 Topic 的讀寫模式。取值說明如下：

  • 6：同時支持讀寫
  • 4：禁寫
  • 2：禁讀
Topic String TP_TEST

Topic 名稱
GmtCreate Long 1570966857000

創建時間
Operator String alipay

創建人
Id Long 1

數據庫 ID

示例

請求示例

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

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/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格式

HTTP/1.1 200 OK
Content-Type:application/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"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。