更新时间:2026-04-03 GMT+08:00

发送消息

功能介绍

发送消息。

URI

POST /v2/{engine}/{project_id}/instances/{instance_id}/messages

表1 路径参数

参数

是否必选

参数类型

描述

engine

String

参数解释

引擎。

约束限制

不涉及。

取值范围

  • rocketmq:RocketMQ消息引擎。

  • reliability:RocketMQ消息引擎别称。

默认取值

不涉及。

project_id

String

参数解释

项目ID,获取方式请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

topic

String

参数解释

主题名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

body

String

参数解释

消息内容。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

property_list

Array of SendMessagePropertiesReqEntity objects

参数解释

特性列表。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表3 SendMessagePropertiesReqEntity

参数

是否必选

参数类型

描述

name

String

参数解释

特性名称。

约束限制

不涉及。

取值范围

  • KEYS:消息标识,是用来标识单条消息的唯一特征的字符串,通常关联业务主键。

  • TAGS:标签,是用来对同一主题(Topic)下的消息进行细分归类的标识。

默认取值

不涉及。

value

String

参数解释

特性值。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

topic

String

参数解释

主题名称。

取值范围

不涉及。

body

String

参数解释

消息内容。

取值范围

不涉及。

property_list

Array of SendMessagePropertiesRespEntity objects

参数解释

特性列表。

msg_id

String

参数解释

消息ID。

取值范围

不涉及。

queue_id

Number

参数解释

队列ID。

取值范围

不涉及。

queue_offset

Number

参数解释

队列offset。

取值范围

不涉及。

broker_name

String

参数解释

Broker名称。

取值范围

不涉及。

表5 SendMessagePropertiesRespEntity

参数

参数类型

描述

name

String

参数解释

特性名称。

取值范围

  • KEYS:消息标识,是用来标识单条消息的唯一特征的字符串,通常关联业务主键。

  • TAGS:标签,是用来对同一主题(Topic)下的消息进行细分归类的标识。

  • UNIQ_KEY:RocketMQ内置的全局唯一标识。

value

String

参数解释

特性值。

取值范围

不涉及。

请求示例

发送消息。

POST https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/messages

{
  "topic" : "aaaaaaaaaaaa",
  "body" : "test",
  "property_list" : [ ]
}

响应示例

状态码:200

发送消息成功。

{
  "topic" : "aaaaaaaaaaaa",
  "body" : "test",
  "property_list" : [ {
    "name" : "UNIQ_KEY",
    "value" : "644F0069A35A0FC5A0FC5AB7244F4573A03FA"
  } ],
  "msg_id" : "644F0E2A315323EAB33D8F4733110009",
  "queue_id" : 0,
  "queue_offset" : 0,
  "broker_name" : "broker-0"
}

状态码

状态码

描述

200

发送消息成功。

错误码

请参见错误码