查询指定环境实例下 Group ID 资源的信息列表。

调试

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

请求参数

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

系统规定参数。取值：ListMqSofamqGroup。
InstanceId String 是 SOFAMQ_INSTANCE_000001

需获取 Group ID 所对应的实例 ID
PageNum Long 是 1

页码
PageSize Long 是 20

每页显示数量
GroupId String 否 GID_test_group_id

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

返回数据

名称 类型 示例值 描述
Data Struct

查询到的订阅关系集合
Content Array

Group 信息
Cluster String SINGLE

集群名
GmtCreate Long 1570966857000

创建时间
GmtModified Long 1570966857000

修改时间
GroupId String test_group_id

Group ID
Id Long 1

数据库 ID
InstanceId String SOFAMQ_INSTANCE_000001

实例 ID
Operator String alipay

操作人
ReadEnable Boolean true

读权限
Remark String test

Group 备注信息
PageNum Long 1

页码
PageSize Long 20

每页显示条数
Total Long 100

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

请求ID
ResultCode String OK

结果码
ResultMessage String OK

结果描述

示例

请求示例

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

正常返回示例

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 格式 

{"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"}

错误码

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