发送消息
功能介绍
发送消息。
URI
POST /v2/{engine}/{project_id}/instances/{instance_id}/messages
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| engine | 是 | String | 参数解释: 引擎。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| project_id | 是 | String | 参数解释: 项目ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| instance_id | 是 | String | 参数解释: 实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| topic | 是 | String | 参数解释: 主题名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| body | 是 | String | 参数解释: 消息内容。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| property_list | 否 | Array of SendMessagePropertiesReqEntity objects | 参数解释: 特性列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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名称。 取值范围: 不涉及。 |
请求示例
发送消息。
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 | 发送消息成功。 |
错误码
请参见错误码。