更新时间:2026-04-03 GMT+08:00

查询指定消费组

功能介绍

查询指定消费组详情。

URI

GET /v2/{project_id}/instances/{instance_id}/groups/{group}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,获取方式请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

group

String

参数解释

消费组名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

enabled

Boolean

参数解释

是否可以消费。

约束限制

不涉及。

取值范围

  • true:可以消费。

  • false:不可以消费。

默认取值

不涉及。

broadcast

Boolean

参数解释

是否广播。

约束限制

不涉及。

取值范围

  • true:开启广播消费。

  • false:不开启广播消费。

默认取值

不涉及。

brokers

Array of strings

参数解释

关联的代理列表。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

name

String

参数解释

消费组名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

group_desc

String

参数解释

消费组描述。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

created_at

Long

参数解释

创建时间。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

retry_max_time

Integer

参数解释

最大重试次数。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

permissions

Array of strings

参数解释

权限。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

consume_orderly

Boolean

参数解释

是否顺序消费。

约束限制

不涉及。

取值范围

  • true:开启顺序消费。

  • false:不开启顺序消费。

默认取值

不涉及。

请求示例

查询指定消费组的详细信息。

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/{group}

响应示例

状态码:200

查询消费组成功。

{
  "name" : "test",
  "group_desc" : "group_description",
  "enabled" : true,
  "broadcast" : true,
  "permissions" : [ ],
  "retry_max_time" : 10,
  "consume_orderly" : false,
  "created_at" : 1768549443385
}

状态码

状态码

描述

200

查询消费组成功。

错误码

请参见错误码