查詢指定環(huán)境實(shí)例下 Group ID 資源的信息列表。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

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

系統(tǒng)規(guī)定參數(shù)。取值：ListMqSofamqGroup。
GroupId String 否 GID_test_group_id

查詢指定 Group ID 時(shí)設(shè)置，否則查詢所有 Group ID。
GroupType String 否 tcp

分組類型，默認(rèn)為 tcp，表示該 Group ID 僅適用于 TCP 協(xié)議的消息收發(fā)。
InstanceId String 是 SOFAMQ_INSTANCE_000001

需獲取 Group ID 所對(duì)應(yīng)的實(shí)例 ID
PageNum Long 是 1

頁碼
PageSize Long 是 20

每頁顯示數(shù)量

返回?cái)?shù)據(jù)

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

結(jié)果描述
ResultCode String OK

結(jié)果碼
RequestId String 861E6630-AEC0-4B2D-B214-6CB5E44B7F04

請(qǐng)求ID
Data Object

查詢到的訂閱關(guān)系集合
PageNum Long 1

頁碼
PageSize Long 20

每頁顯示條數(shù)
Total Long 100

總條數(shù)
Content Array of Content

Group 信息
RetryPerm Long 6

重試權(quán)限
Cluster String SINGLE

集群名
Remark String test

Group 備注信息
InstanceId String SOFAMQ_INSTANCE_000001

實(shí)例 ID
GmtModified Long 1570966857000

修改時(shí)間，單位：毫秒
RetryWriteQueueNum Long 1

重試寫隊(duì)列權(quán)限
DeleteMark String 0

刪除標(biāo)記
GroupId String test_group_id

Group ID
Version Long 1

版本
GmtCreate Long 1570966857000

創(chuàng)建時(shí)間，單位：毫秒
RetryReadQueueNum Long 1

重試讀隊(duì)列數(shù)量
Scope String *

作用范圍
Operator String alipay

操作人
GroupType String tcp

分組類型，默認(rèn)為 tcp，表示該 Group ID 僅適用于 TCP 協(xié)議的消息收發(fā)。
ReadEnable Boolean true

讀權(quán)限
Id Long 1

數(shù)據(jù)庫(kù) ID

示例

請(qǐng)求示例

http(s)://[Endpoint]/?Action=ListMqSofamqGroup
&InstanceId=SOFAMQ_INSTANCE_000001
&PageNum=1
&PageSize=20
&<公共請(qǐng)求參數(shù)>

正常返回示例

XML格式

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

<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>
<Data>
    <PageNum>1</PageNum>
    <PageSize>20</PageSize>
    <Content>
        <Operator>alipay</Operator>
        <GmtCreate>1570966857000</GmtCreate>
        <InstanceId>SOFAMQ_INSTANCE_000001</InstanceId>
        <GmtModified>1570966857000</GmtModified>
        <ReadEnable>true</ReadEnable>
        <Cluster>SINGLE</Cluster>
        <Id>1</Id>
        <GroupId>test_group_id</GroupId>
        <Remark>test</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" : "20",
    "Content" : [ {
      "Operator" : "alipay",
      "GmtCreate" : "1570966857000",
      "InstanceId" : "SOFAMQ_INSTANCE_000001",
      "GmtModified" : "1570966857000",
      "ReadEnable" : "true",
      "Cluster" : "SINGLE",
      "Id" : "1",
      "GroupId" : "test_group_id",
      "Remark" : "test"
    } ],
    "Total" : "100"
  },
  "ResultMessage" : "OK",
  "ResultCode" : "OK"
}

錯(cuò)誤碼

訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。