使用OnsGroupList API查询Group ID列表-云消息队列 RocketMQ 版-阿里云

查询指定实例下所有的Group ID信息。

接口说明

注意阿里云提供的 OpenAPI 属于管控类 API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖 OpenAPI 实现，否则可能会导致链路产生风险。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
mq:ListGroup	list	Group `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	无	mq:QueryInstanceBaseInfo

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	需获取资源列表的 Group ID 所对应的实例 ID。	MQ_INST_111111111111_DOxxxxxx
GroupId	string	否	模糊查询指定 Group ID 时设置，否则查询所有 Group ID。如果输入 GID_ABC 查询，那么会以前后缀匹配的方式进行模糊查询，返回所有包含GID_ABC的 Group ID，例如 GID_test_GID_ABC_123、GID_ABC_356。	GID_test_group_id
GroupType	string	否	查询的 Group ID 适用的协议。TCP 协议和 HTTP 协议的 Group ID 不可以共用，需要分别创建。取值说明如下： tcp：默认值，表示该 Group ID 仅适用于 TCP 协议的消息收发。 http：表示该 Group ID 仅适用于 HTTP 协议的消息收发。	tcp
Tag	array<object>	否	Group ID 所绑定的标签列表。列表元素个数不得超过 20。
	object	否
Key	string	是	Group ID 的标签键。Key 和 Value 值必须同时输入或同时不输入。若同时输入表示根据 Tag 过滤符合条件的 Group ID，若不输入表示查询所有 Group ID。如果输入该值，则取值不允许为空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	CartService
Value	string	是	Group ID 的标签值。Key 和 Value 值必须同时输入或同时不输入。若同时输入表示根据 Tag 过滤符合条件的 Group ID，若不输入表示查询所有 Group ID。如果输入该值，取值允许为空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	ServiceA

返回参数

名称	类型	描述	示例值
	object
RequestId	string	公共参数，每个请求的 ID 都是唯一的，可用于排查和定位问题。	16996623-AC4A-43AF-9248-FD9D2D75****
Data	array<object>	查询到的订阅关系集合。
SubscribeInfoDo	object
Owner	string	该发布信息的拥有者。	138015630679****
UpdateTime	long	该 Group ID 的更新时间。	1570700979000
IndependentNaming	boolean	实例是否有命名空间。取值说明如下： true：拥有独立命名空间，资源命名确保实例内唯一，跨实例之间可重名。 false：无独立命名空间，实例内或者跨实例之间，资源命名必须全局唯一。	true
GroupId	string	Group ID 即消费集群组 ID。	GID_test_group_id
Remark	string	备注。	test
CreateTime	long	Group ID 的创建时间。	1568896605000
Tags	array<object>	Group ID 所绑定的标签。
Tag	object
Key	string	标签键。	CartService
Value	string	标签值。	ServiceA
InstanceId	string	实例 ID。	MQ_INST_111111111111_DOxxxxxx
GroupType	string	查询的 Group ID 适用的协议。TCP 协议和 HTTP 协议的 Group ID 不可以共用，需要分别创建。取值说明如下： tcp：表示该 Group ID 仅适用于 TCP 协议的消息收发。 http：表示该 Group ID 仅适用于 HTTP 协议的消息收发。	tcp

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史