消息队列 JCQ

产品文档

消息队列 JCQ

收消息

  • 请求行
GET {Http接入点}/v2/messages HTTP/1.1
  • 请求headers参数

请求公共参数请参考公共参数签名算法章节。

  • Request Parameters
字段名 字段类型 必填 说明
topic string Required
consumerGroupId string Required
size int32 Optional 一次最多拉取消息条数,0 < size <=32,defaultValue = 32
consumerId string Optional defaultValue = httpProxyId
consumeFromWhere string Optional 默认的起始消费位置,可选值:HEAD、TAIL,defaultValue = HEAD
filterExpressionType string Optional 消息过滤表达式类型,目前可选值只有TAG
filterExpression string Optional 消息过滤表达式,默认没有过滤,如果需要过滤,此参数与filterExpressionType需同时传入
ack string Optional 拉消息时是否由服务端自动ACK,ACK 必须在消息确认接收的超时时间内,可选值true、false,为true时,服务端自动ACK消费的消息,为false时,需要客户端来ACK消费的消息,默认值defaultValue = false
  • Response Body

1.请求成功

字段名 字段类型 说明
requestId string 本次请求的requestId,用于搜索调用链
result map 返回格式为:{"topicName":"lizhijian-041","ackIndex":"broker-31","messages":[{"messageId":"messageId_1","messageBody":"test-0","properties":{"TAGS":"world"}},{"messageId":"messageId_2","messageBody":"test-2","properties":{"TAGS":"world"}}]}

2.请求失败

字段名 字段类型 说明
requestId string 本次请求的requestId,用于搜索调用链
error map 返回格式为:{"code":500,"message":"Topic information query failure","status":"INTERNAL"}

说明: Https消息收发,除请求中的Http接入点需替换为Https接入点外,接口同Http。

更新时间:2021-04-28 18:21:56
文档反馈 docs feedback