查看所有队列
功能介绍
查看所有队列。
URI
GET /v1.0/{project_id}/queues?include_deadletter={include_deadletter}
参数说明请参见表1。
|
名称 |
类型 |
是否必选 |
说明 |
|---|---|---|---|
|
project_id |
String |
是 |
项目ID。 |
|
include_deadletter |
Boolean |
否 |
是否包含死信信息。 支持的值如下:
默认值为:false。 Kafka队列没有死信功能,该参数对于Kafka队列无效。 |
GET v1.0/b78a90ae2a134b4b8b2ba30acab4e23a/queues?&include_deadletter=true
请求消息
请求参数
无。
请求示例
无。
响应消息
响应参数
|
参数 |
类型 |
描述 |
|---|---|---|
|
id |
String |
队列ID。 |
|
name |
String |
队列的名称。 |
|
created |
String |
创建队列的时间。 |
|
description |
String |
队列的描述信息。 |
|
queue_mode |
String |
队列类型。 |
|
reservation |
Integer |
消息在队列中允许保留的时长(单位分钟)。 |
|
max_msg_size_byte |
Integer |
队列中允许的最大消息大小(单位Byte)。 |
|
produced_messages |
Integer |
队列的消息总数。 |
|
redrive_policy |
String |
该队列是否开启死信消息。仅当include_deadletter为true时,才有该响应参数。
|
|
max_consume_count |
Integer |
最大确认消费失败的次数,当达到最大确认失败次数后,DMS会将该条消息转存到死信队列中。 仅当include_deadletter为true时,才有该响应参数。 |
|
group_count |
Integer |
该队列下的消费组数量。 |
|
eff_date |
String |
创建队列的时间。 |
响应示例
{
"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
}, {
"id" : "bc0ac1ec-a4d6-4490-84cb-9d475f1ec3c5",
"name" : "aaa_normal_525",
"description" : "test",
"queue_mode" : "NORMAL",
"reservation" : 4320,
"created" : 1495701490000,
"max_msg_size_byte" : 524288,
"produced_messages" : 0,
"redrive_policy" : "enable",
"max_consume_count" : 3,
"eff_date": 1495701490000,
"group_count" : 0
}, {
"id" : "1aaf34d0-7bb0-43be-9b71-f4b719d7ca47",
"name" : "queue-normal",
"description" : null,
"queue_mode" : "NORMAL",
"reservation" : 4320,
"created" : 1495447342000,
"max_msg_size_byte" : 524288,
"produced_messages" : 2,
"redrive_policy" : "enable",
"max_consume_count" : 3,
"eff_date": 1495447342000,
"group_count" : 0
}, {
"id" : "f685ed59-43f4-4cf9-b609-7f333820d72d",
"name" : "queue-835807102",
"description" : "",
"reservation" : 2160,
"created" : 1517379348000,
"queue_mode" : "KAFKA_HA",
"max_msg_size_byte" : 524288,
"produced_messages" : 0,
"eff_date": 1517379348000,
"group_count" : 0
}
],
"total" : 4
}