消息发送
消息发送 Request
请求 URL | http://domain/message/ |
请求 Method | POST |
参数名称 | 参数类型 | 是否必须 | 说明 |
AccessKey | String | 是 | 阿里云身份验证 |
Signature | String | 是 | 身份验证签名,生成方式:topic+”\n”+ ProducerId +”\n”+md5(body)+”\n”+time |
ProducerId | String | 是 | 消息发布组 ID |
isOrder | boolean | 否 | 是否是顺序消息,需要和 shardingKey 组合使用。 isOrder为 true,shardingKey 有值才有效。相同的 Topic,shardingKey 相同的消息会发送到同一个queue里面。 |
shardingKey | String | 否 | 顺序消息 shardingKey |
参数名称 | 参数类型 | 是否必须 | 说明 |
topic | String | 是 | 消息 Topic |
timeout | Long | 否 | 超时时间,单位毫秒,取值范围1000-3000,默认3000 |
time | Long | 是 | 客户端时间戳(自1970-01-01, 00:00:00 GMT 经历的毫秒数,如果 MQ 收到时间戳已经过了15s,那么会返回403。) |
tag | String | 否 | 消息 Tag 长度:128字符以内,UTF-8 编码 |
key | String | 否 | 消息 Key 长度:128字符以内,UTF-8 编码 |
secondTopic | String | 否 | MQTT 的 second Topic,qos为1,暂不支持从http设置其他qos |
startdelivertime | Long | 否 | 定时消息时间(自1970-01-01,00:00:00 GMT 经历的毫秒数)。当 Topic 为顺序 Topic 时 startdelivertime 无效,请使用非顺序 Topic。 |
Status code | 说明 | Body(JSON 格式) |
201 | 消息添加成功 | {“msgId”:”0A021F7300002A9F0000000006531D6F”,”sendStatus”:”SEND_OK”} |
400 | 请求失败 | {“code”:”BODY_TOO_BIG”,”info”:”Message body size exceeds the upper limit of 64KB”} |
403 | 鉴权失败 | 无,请检查签名生成方式代码是否正确,AccessKey,SecretKey 填写是否正确,date 时间和互联网时间是否一致。 |
408 | 请求超时 | 无,请检查网络是否异常 |
请求 URL | http://domain/message/ |
请求 Method | GET |
参数名称 | 参数类型 | 是否必须 | 说明 |
AccessKey | String | 是 | 阿里云身份验证 |
Signature | String | 是 | 身份验证签名,生成方式:topic+”\n”+ ConsumerId +”\n”+time |
ConsumerId | String | 是 | 消费者 ID |
参数名称 | 参数类型 | 是否必须 | 说明 |
topic | String | 是 | 消息 Topic |
timeout | Long | 否 | 超时时间,单位毫秒,取值范围20000-35000,默认35000。 |
time | Long | 是 | 客户端时间戳(自1970-01-01, 00:00:00 GMT 经历的毫秒数,如果 MQ 收到时间戳已经过了15s,那么会返回403。) |
num | int | 否 | 拉取返回消息数量,默认32。取值范围 1-32。 |
Status code | 说明 | Body(JSON 格式) |
200 | 消息读取成功 | [{“body”:”HelloMQ”,”bornTime”:”1418973464204”, “msgHandle”:”X1BFTkRJTkdNU0dfXyVSRVRSWSUkbG9uZ2ppJENJRF9sb25namlfdGxvbmdqaQ==”, “msgId”:”0A021F7300002A9F000000000647076D”,”reconsumeTimes”:1}] |
400 | 请求失败 | {“code”:”TOPIC_NOT_EXIST”,”info”:”topic not exist”} |
403 | 鉴权失败 | 无,请检查签名生成方式代码是否正确,AccessKey,SecretKey 填写是否正确,date 时间和互联网时间是否一致。 |
408 | 请求超时 | 无,请检查网络是否异常。 |
请求 URL | http://domain/message/ |
请求 Method | DELETE |
参数名称 | 参数类型 | 是否必须 | 说明 |
AccessKey | String | 是 | 阿里云身份验证 |
Signature | String | 是 | 身份验证签名,生成方式:topic+”\n”+ ConsumerId + “\n” + msgHandle + ”\n” + time |
ConsumerId | String | 是 | 消费者 ID |
参数名称 | 参数类型 | 是否必须 | 说明 |
topic | String | 是 | 消息 Topic |
msgHandle | String | 是 | get 返回消息的 handle |
time | Long | 是 | 客户端时间戳(自1970-01-01, 00:00:00 GMT 经历的毫秒数,如果 MQ 收到时间戳已经过了15s,那么会返回403。) |
Status code | 说明 | Body(JSON 格式) |
204 | 消息删除成功 | 无返回内容 |
400 | 请求失败 | {“code”:”TOPIC_NOT_EXIST”,”info”:”topic not exist”} |
403 | 鉴权失败 | 无,请检查签名生成方式代码是否正确,AccessKey,SecretKey 填写是否正确,date 时间和互联网时间是否一致。 |
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。