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

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

消费死信消息

功能介绍

消费指定消费组产生的死信消息。可同时消费多条消息,每次消费的消息负载不超过512KB。

仅NORMAL队列和FIFO队列可以开启死信消息,因为只有NORMAL队列和FIFO队列可消费死信消息。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

queue_id

String

指定的队列ID。

consumer_group_id

String

消费组的ID。

表2 Query参数

参数

是否必选

参数类型

描述

max_msgs

Integer

获取可消费的死信消息的条数。

说明:

单次消费返回的消息数量可能会少于指定条数,但多次消费最终可获取全部消息。

取值范围:1~10。

默认值:10

time_wait

Integer

设定消费组中可消费的死信为0时的读取消息等待时间。

如果在等待时间内有新的死信消息,则立即返回消费结果,如果等待时间内没有新的死信消息,则到等待时间后返回消费结果。

取值范围:1~60s

默认值:3s

说明:不带该参数或者配置为空,都默认为3s。

ack_wait

Integer

commit提交超时时间,在该时间内提交确认,确认有效,如果超过指定时间,系统会报消息确认超时,或handler无效。

取值范围:15~300s

默认值:30s

说明:不带该参数或者配置为空,都默认为30s。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

[数组元素]

Array of ConsumeDeadlettersMessage objects

消息数组。

表4 ConsumeDeadlettersMessage

参数

参数类型

描述

message

message object

消息的内容。

handler

String

消息handler。

表5 message

参数

参数类型

描述

body

Object

消息体的内容。

attributes

Object

属性的列表。

请求示例

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

响应示例

状态码: 200

获取信息成功。

[ {
  "message" : {
    "body" : {
      "foo" : "123="
    },
    "attributes" : {
      "attribute1" : "value1",
      "attribute2" : "value2"
    }
  },
  "handler" : "eyJjZyI6Im15X2pzb25fZ3JvdXAiLCJjaSI6InJlc3QtY29uc3VtZXItYzNlNThiNjEtYzA0NC00NGJkLTkxM2ItZDgzNjljNmJhYTQxIiwiY291bnQiOjAsIm9mZnNldCI6MCwicCI6MCwidCI6InRlc3QyIn0="
}, {
  "message" : {
    "body" : {
      "foo" : "123="
    },
    "attributes" : {
      "attribute1" : "value1",
      "attribute2" : "value2"
    }
  },
  "handler" : "eyJjZyI6Im15X2pzb25fZ3JvdXAiLCJjaSI6InJlc3QtY29uc3VtZXItYzNlNThiNjEtYzA0NC00NGJkLTkxM2ItZDgzNjljNmJhYTQxIiwiY291bnQiOjAsIm9mZnNldCI6MSwicCI6MCwidCI6InRlc3QyIn0="
} ]

状态码

状态码

描述

200

获取信息成功。

错误码

请参见错误码

分享:

    相关文档

    相关产品