MessageSend - 发送消息--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

MessageSend - 发送消息

最近更新时间：2024.11.18 10:27:32首次发布时间：2024.07.26 16:53:22

调用 MessageSend 接口，向指定 Topic 发送普通消息，验证消息发送链路是否通畅。

使用说明

此接口用于向指定 Topic 发送消息，验证消息发送链路是否通畅。消息发送后，您可以调用消息查询接口，校验消息是否成功发送到服务端。

QueryMessageByMsgId：根据 MessageId 查询消息。
QueryMessageByMsgKey：根据 MessageKey 查询消息。
QueryMessageByTimestamp：根据时间范围查询消息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	MessageSend	要执行的操作，取值：MessageSend。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
Topic	String	是	topic-1	目标 Topic 的名称，即向该 Topic 发送消息。
Tag	String	否	TagA	自定义设置消息 Tag。可以用来进一步对某个 Topic 下的消息进行分类，RocketMQ 允许消费者按照 Tag 对消息进行过滤。
Key	String	否	key-1	需要发送的消息的 Message Key。消息发送后，您可以通过 Message Key 来查询消息。
Body	String	是	Hello world	需要发送的消息的具体内容。
InstanceId	String	是	rocketmq-cna****	实例 ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
MsgId	String	AC14B5D0000100****	消息发送成功，返回每条消息的唯一 ID。可以通过消息 ID 查询消息。
OffsetMsgId	String	AC17E269000078BF**	消息在服务端生成的 ID，主要包含了服务端地址和 commitlog offset。
QeueueOffset	Integer	0	消息在队列的 offset 位点。
SendStatus	String	SEND_OK	消息发送结果状态。 SEND_OK：发送成功 SEND_FAIL：发送失败

请求示例

POST /?Action=MessageSend&Version=2023-01-01 HTTP/1.1
Content-Type: application/json
Host: rocketmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20230328/cn-shanghai/rocketmq/request, SignedHeaders=x-date, Signature=********

{
  "InstanceId": "rocketmq-cnngcc**",
  "Topic": "topic-1",
  "Body": "Hello world",
  "Tag": "TagA",
  "Key": "key-1"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240726154927655256FBCC88D***",
        "Action": "MessageSend",
        "Version": "2023-01-01",
        "Service": "rocketmq",
        "Region": "cn-beijing"
    },
    "Result": {
        "MsgId": "0B539E9A000100000000842**",
        "Msgqueue": null,
        "OffsetMsgId": "0B9F9105000078BF000000***",
        "QeueueOffset": 0,
        "SendStatus": "SEND_OK"
    }
}

错误码

公共错误码请参见公共错误码文档。