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

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

查看所有队列

功能介绍

查看所有队列。

调试

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

URI

GET /v2/{project_id}/queues

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

include_deadletter

Boolean

是否包含死信信息。

支持的值如下:

  • true:包含死信消息。

  • false:不包含死信消息。

默认值为:false。

Kafka队列没有死信功能,该参数对于Kafka队列无效。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

total

Integer

该租户的所有队列总数。

queues

Array<Object>

该租户的所有队列数组。

表4 queues

参数

参数类型

描述

id

String

队列ID。

name

String

队列的名称。

created

Integer

创建队列的时间。

description

String

队列的描述信息。

queue_mode

String

队列类型。

reservation

Integer

消息在队列中允许保留的时长(单位分钟)。

max_msg_size_byte

Integer

队列中允许的最大消息大小(单位Byte)。

produced_messages

Integer

队列的消息总数。

redrive_policy

String

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

  • enable:表示开启。

  • disable:表示不开启。

max_consume_count

Integer

最大确认消费失败的次数,当达到最大确认失败次数后,DMS会将该条消息转存到死信队列中。

仅当include_deadletter为true时,才有该响应参数。

group_count

Integer

该队列下的消费组数量。

eff_date

Integer

创建队列的时间。

请求示例

GET https://{endpoint}/v2/b78a90ae2a134b4b8b2ba30acab4e23a/queues?&include_deadletter=true

响应示例

状态码: 200

查询成功。

{
  "queues" : [ {
    "id" : "ef808d2d-58c2-4a36-9e58-d018b2193f80",
    "name" : "aaa_fifo_525",
    "description" : "test_fifo_detail",
    "queue_mode" : "NORMAL",
    "reservation" : 4320,
    "created" : 1495701557000,
    "max_msg_size_byte" : 524288,
    "produced_messages" : 1,
    "redrive_policy" : "enable",
    "max_consume_count" : 3,
    "eff_date" : 1495701557000,
    "group_count" : 0
  } ],
  "total" : 1
}

状态码

状态码

描述

200

查询成功。

错误码

请参见错误码

分享:

    相关文档

    相关产品