全部产品
Search
文档中心

轻量消息队列(原 MNS):SendMessage

更新时间:Dec 13, 2024

调用SendMessage接口发送消息到指定的队列。

授权信息

默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。本接口的授权信息如下表所示。更多信息,请参见授权策略和示例

Name

Value

API

SendMessage

RAM授权操作

mns:SendMessage

资源

acs:mns:$region:$accountid:/queues/$queueName/messages

使用说明

  • 该接口用于发送消息到指定的队列,普通消息发送到队列立即被消费者消费。如果生产者发送一个消息不想立即被消费者消费(典型的使用场景为定期任务),生产者可以在发送消息时设置DelaySeconds参数。发送带DelaySeconds参数值大于0的消息初始状态为Delayed,此时消息不能被消费者消费,只有等DelaySeconds时间后消息变成Active状态后才可以被消费。

  • 发送消息时指定DelaySeconds参数的优先级高于延时队列的DelaySeconds属性,即两个DelaySeconds属性设置的值不同的时候以发送消息时指定的值为准。

  • 当您调用API发送消息时,请事先将消息体进行Base64编码,以免存在特殊字符导致不能正常使用。

请求消息

请求消息由请求行、HTTP头和消息体三部分组成:

  • 请求行

    POST /queues/$queueName/messages HTTP/1.1

  • 特有Request Header

    无。

  • Request Body

    Request Body为XML格式,其中包含创建Message的属性。

    参数名称

    类型

    是否必选

    示例值

    描述

    MessageBody

    String

    This is a test message

    消息正文。

    DelaySeconds

    Integer

    60

    消息发送后,经过DelaySeconds设置的时间后可被消费。

    取值范围:0~604800,单位为秒。

    默认值:0。

返回消息

返回消息由返回状态行、HTTP头和消息体三部分组成:

  • HTTP Status Code

    HTTP/1.1 201 Created

  • 特有Response Header

    无。

  • Response Body

    Response Body为XML格式,返回Message的MessageId和MessageBodyMD5子元素。

    参数名称

    类型

    示例值

    描述

    MessageId

    String

    5F290C926D472878-2-14D9529A8FA-20000****

    消息编号,在一个队列中唯一。

    MessageBodyMD5

    String

    C5DD56A39F5F7BB8B3337C6D11B6****

    消息正文的MD5值。

    ReceiptHandle

    String

    1-ODU4OTkzNDU5My0xNDM1MTk3NjAwLTItNg==

    发送延迟消息后返回的消息句柄。

示例

请求示例:

POST /queues/$queueName/messages HTTP/1.1
Host: $AccountId.mns.cn-hangzhou.aliyuncs.com
Date: Wed, 18 Mar 2012 12:00:00 GMT
Content-Length:500
Content-Type:text/xml;charset=utf-8
x-mns-version: 2015-06-06
Authorization: MNS 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEX****

<?xml version="1.0" encoding="UTF-8"?>
<Message xmlns="http://mns.aliyuncs.com/doc/v1/">
    <MessageBody>This is a test message</MessageBody>
    <DelaySeconds>60</DelaySeconds>
    <Priority>1</Priority>
</Message>            

返回示例:

HTTP/1.1 201 Created
Content-Length:120
Content-Type:text/xml;charset=utf-8
x-mns-request-id:512B2A634403E52B1956****
x-mns-version: 2015-06-06

<?xml version="1.0" encoding="UTF-8"?>
<Message xmlns="http://mns.aliyuncs.com/doc/v1/">
<MessageId>5F290C926D472878-2-14D9529****-200000001</MessageId>
<MessageBodyMD5>C5DD56A39F5F7BB8B3337C6D11B6****</MessageBodyMD5>
<ReceiptHandle>1-ODU4OTkzNDU5My0xNDM1MTk3NjAwLTItNg==</ReceiptHandle>
</Message>           

错误码

错误码

错误信息

HTTP状态码

描述内容

QueueNotExist

The queue name you provided is not exist.

404

队列不存在,请先创建队列。

MalformedXML

The XML you provided was not well-formed.

400

XML结构异常。

InvalidArgument

The value of Element should between Low and High seconds/bytes.

400

参数值非法,请根据提示调整。