调用OnsGroupList查询账号下所有的Group信息列表。

使用说明

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

QPS限制

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

授权信息

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

调试

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

请求参数

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

系统规定参数。取值:OnsGroupList

InstanceId String MQ_INST_111111111111_DOxxxxxx

需获取资源列表的Group ID所对应的实例ID。

Tag.N.Key String CartService

资源的标签键。

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

资源的标签值。

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

模糊查询指定Group ID时设置,否则查询所有Group ID。

如果输入GID_ABC查询,那么会以前后缀匹配的方式进行模糊查询,返回所有包含*GID_ABC*的Group ID,例如GID_test_GID_ABC_123、GID_ABC_356。

GroupType String tcp

查询的Group ID适用的协议。TCP协议和HTTP协议的Group ID不可以共用,需要分别创建。取值说明如下:

  • tcp:默认值,表示该Group ID仅适用于TCP协议的消息收发。
  • http:表示该Group ID仅适用于HTTP协议的消息收发。

返回数据

名称 类型 示例值 描述
Data Array of SubscribeInfoDo

查询到的订阅关系集合。

SubscribeInfoDo
CreateTime Long 1568896605000

GroupID的创建时间。

GroupId String GID_test_group_id

消费集群组ID。

GroupType String tcp

查询的Group ID适用的协议。TCP协议和HTTP协议的Group ID不可以共用,需要分别创建。取值说明如下:

  • tcp:表示该Group ID仅适用于TCP协议的消息收发。
  • http:表示该Group ID仅适用于HTTP协议的消息收发。
IndependentNaming Boolean true

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

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

实例ID。

Owner String 138015630679****

该发布信息的拥有者。

Remark String test

备注。

Tags Array of Tag

Group ID所绑定的标签。

Tag
Key String CartService

标签键。

Value String ServiceA

标签值。

UpdateTime Long 1570700979000

该Group ID的更新时间。

RequestId String 16996623-AC4A-43AF-9248-FD9D2D75****

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

示例

请求示例

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsGroupList
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&Tag.1.Key=CartService
&Tag.1.Value=ServiceA
&<公共请求参数>

正常返回示例

XML格式

<OnsGroupListResponse>
  <RequestId>16996623-AC4A-43AF-9248-FD9D2D75****</RequestId>
  <Data>
        <SubscribeInfoDo>
              <Owner>138015630679****</Owner>
              <GroupType>tcp</GroupType>
              <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>
              <CreateTime>1568896605000</CreateTime>
              <UpdateTime>1570700979000</UpdateTime>
              <IndependentNaming>true</IndependentNaming>
              <GroupId>GID_test_group_id</GroupId>
              <Remark>test</Remark>
              <Tags>
                    <Tag>
                          <Value>ServiceA</Value>
                          <Key>CartService</Key>
                    </Tag>
              </Tags>
        </SubscribeInfoDo>
  </Data>
</OnsGroupListResponse>

JSON格式

{
        "RequestId": "16996623-AC4A-43AF-9248-FD9D2D75****",
        "Data": {
            "SubscribeInfoDo": [
                {
                "Owner": "138015630679****",
                "GroupType": "tcp",
                "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
                "CreateTime": 1568896605000,
                "UpdateTime": 1570700979000,
                "IndependentNaming": true,
                "GroupId": "GID_test_group_id",
                "Remark": "test",
                "Tags": {
                    "Tag": [
                        {
                        "Value": "ServiceA",
                        "Key": "CartService"
                        }
                        ]
                    }
                }
            ]             
    }
}

错误码

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