分布式消息服务 DMS分布式消息服务 DMS

更新时间:2021/06/16 GMT+08:00
分享

查看指定队列的所有消费组

功能介绍

获取指定队列的所有消费组。

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{project_id}/queues/{queue_id}/groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

queue_id

String

指定的队列ID

表2 Query参数

参数

是否必选

参数类型

描述

include_deadletter

Boolean

是否包含死信信息。默认值为:false

include_messages_num

Boolean

是否查询消费组的详情,默认值为true。

配置为false时,查询的消费组列表不包含消费详情,接口响应速度快。

page_size

Integer

设置每页显示的消费组数量。

page_size和current_page必须同时配置有效值,否则默认查询所有消费组。

current_page

Integer

设置查询消费组的页码。

page_size和current_page必须同时配置有效值,否则默认查询所有消费组。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

queue_id

String

队列ID。

queue_name

String

队列的名称。

groups

Array<Object>

消费组列表。

redrive_policy

String

该队列是否开启死信消息。仅当include_deadletter为true时,才有该响应参数。

  • enable:表示开启。

  • disable:表示不开启。

表4 groups

参数

参数类型

描述

id

String

队列的名称。

name

String

队列的名称。

produced_messages

Integer

队列的消息总数,不包含过期删除的消息数。

consumed_messages

Integer

已正常消费的消息总数。

available_messages

Integer

该消费组可以消费的普通消息数。

produced_deadletters

Integer

该消费组产生的死信息消息总数。仅当include_deadletter为true时,才有该响应参数。

available_deadletters

Integer

该消费组未消费的死信消息数。仅当include_deadletter为true时,才有该响应参数。

请求示例

GET https://{endpoint}/v2/{project_id}/queues/{queue_id}/groups

响应示例

状态码: 200

获取信息成功。

{
  "queue_id" : "f5b6dd28-08dd-4f0f-866c-2eadf6788163",
  "queue_name" : "queue-772289871",
  "groups" : [ {
    "name" : "group-1690260950",
    "id" : "g-eb9305bb-5bec-4712-84ab-0a36fbe9c2c0",
    "consumed_messages" : 0,
    "available_messages" : 8,
    "produced_messages" : 10
  } ],
  "redrive_policy" : "enable"
}

状态码

状态码

描述

200

获取信息成功。

错误码

请参见错误码

分享:

    相关文档

    相关产品