查看指定队列
功能介绍
查看指定的队列。
URI
GET /v1.0/{project_id}/queues/{queue_id}?include_deadletter={include_deadletter}
参数说明请参见表1。
|
名称 |
类型 |
是否必选 |
说明 |
|---|---|---|---|
|
project_id |
String |
是 |
项目ID。 |
|
queue_id |
String |
是 |
待查询的队列ID。 |
|
include_deadletter |
Boolean |
否 |
是否包含死信信息。 支持的值如下:
默认值为:false。 Kafka队列没有死信功能,该参数对于Kafka队列无效。 |
GET v1.0/b78a90ae2a134b4b8b2ba30acab4e23a/queues/075ae7da-6ce5-4966-940c-17c19fb5175e?include_deadletter=true
请求消息
请求参数
无。
请求示例
无。
响应消息
响应参数
响应参数如表2所示。
|
参数 |
类型 |
描述 |
|---|---|---|
|
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 |
该队列下的消费组数量。 |
|
kafka_topic |
String |
仅Kafka队列才有该参数。 |
|
eff_date |
String |
创建队列的时间。 |
响应示例
{
"id": "0611d466-a327-4b7b-8034-f84a0f6a6f42",
"name": "queue-001",
"description": "This is a FIFO queue.",
"reservation": 4320,
"created": 1558691803000,
"queue_mode": "FIFO",
"max_msg_size_byte": 524288,
"produced_messages": 14,
"eff_date": 1558691803000,
"group_count": 1
}