消费消息

POST

https://api2.hik-cloud.com/api/v1/mq/consumer/messages

功能描述

1.该接口用于拉取消息，消费消息请在单线程中进行消费，禁止使用多线程进行消费。

2.消费者创建成功之后，循环调用该接口拉取消息，无需每次拉取消息都创建消费者。

3.消费者首次拉取消息时需要与消息通道建立连接，此次调用实际拉到消息列表为空，再次调用即可拉取到消息，30秒内必须再次调用拉取消息接口，否则将断开与消息通道的连接。因此拉取间隔需要在30秒以内，否则每次拉到的消息是空的

4.每次拉取到的消息大小上限为1M（500条左右）

5.若采用手动提交偏移量消费模式，则正确的消费方式是，单线程内拉取一次消息，判断消息列表不为空，则提交一次偏移量，请注意：提交偏移量和消费消息必须使用同一consumerId。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api2.hik-cloud.com/api/v1/mq/consumer/messages' \
--header 'Authorization: Bearer '

响应示例

{
    "code": "200",
    "message": "操作成功",
    "success": true,
    "data": [
        {
            "msgId": "334acaac80154fe89195d5c20d3c7808",
            "msgType": "详见具体消息类型定义",
            "content": "详见具体消息类型格式定义"
        }
    ]
}

请求参数

Header 参数

Authorization

string

可选

默认值:

Bearer {{access_token}}

Body 参数application/x-www-form-urlencoded

consumerId

string

消费者ID

可选

autoCommit

string

可选

是否自动提交偏移量，默认false

返回响应

🟢200成功

application/json

Body

code

string

返回码

必需

message

string

返回消息

必需

success

boolean

消息列表

必需

data

array [object {3}]

必需

msgId

string

消息ID,每条消息的唯一ID,消费者可根据此ID进行去重处理

必需

msgType

string

消息类型

必需

content

string

消息内容

必需

创建消费者

提交偏移量

消费消息

功能描述#

请求参数

返回响应

功能描述