文档

BatchSendMessage

更新时间:

调用BatchSendMessage接口批量发送消息到指定的队列。

授权信息

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

Name

Value

API

BatchSendMessage

RAM授权操作

mns:BatchSendMessage

资源

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

使用说明

  • 该接口用于批量发送消息到指定的队列,一次BatchSendMessage最多发送16条消息(一次Batch请求的消息总大小不得超过64 KB)。普通消息发送到队列立即被消费者消费,如果生产者发送一个消息不想立即被消费者消费(典型的使用场景为定期任务),生产者可以在发送消息时设置DelaySeconds参数。

  • 发送带DelaySeconds参数值大于0的消息初始状态为Delayed,此时消息不能被消费者消费,只有等DelaySeconds时间后消息变成Active状态后才可消费。发送消息时指定DelaySeconds参数的优先级高于延时消息队列的DelaySeconds属性,即两个DelaySeconds属性设置的值不同的时候以发送消息时指定的值为准。

  • 使用BatchSendMessage接口时,BatchSendMessage接口每秒最大并发请求数=限流比对值/接口中消息条数。例如:单个队列的QPS使用限制为3000,当BatchSendMessage接口中发送100条消息时,那么BatchSendMessage接口每秒最大并发为3000/100 = 30次。

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

请求消息

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

  • 请求行

    POST /queues/$queueName/messages HTTP/1.1

  • 特有Request Header

    无。

  • Request Body

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

    参数名称

    类型

    是否必选

    示例值

    描述

    MessageBody

    String

    This is test message 1.

    消息正文。

    DelaySeconds

    Integer

    60

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

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

    默认值:0。

    Priority

    Integer

    1

    指定消息的优先级权值,优先级更高的消息,将更早被消费。

    取值范围:1~16,数值越小优先级越高。

    默认值:8。

返回消息

返回消息由返回状态行、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值。

示例

请求示例:

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+FIEXA****

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

返回示例:

  • 正常发送所有消息

        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"?>
        <Messages xmlns="http://mns.aliyuncs.com/doc/v1/">
        <Message>
            <MessageId>5F290C926D472878-2-14D9529A8FA-20000****</MessageId>
            <MessageBodyMD5>C5DD56A39F5F7BB8B3337C6D11B6****</MessageBodyMD5>
        </Message>
        <Message>
            <MessageId>5F290C926D472878-2-14D9529A8FA-20000****</MessageId>
            <MessageBodyMD5>377AC5283D8765C9CEE4E0EA353D****</MessageBodyMD5>
        </Message>
        </Messages>                   
  • 只发送了部分消息

        HTTP/1.1 500
        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"?>
        <Messages xmlns="http://mns.aliyuncs.com/doc/v1/">
        <Message>
            <MessageId>5F290C926D472878-2-14D9529A8FA-20000****</MessageId>
            <MessageBodyMD5>C5DD56A39F5F7BB8B3337C6D11B6****</MessageBodyMD5>
        </Message>
        <Message>
            <MessageId>5F290C926D472878-2-14D9529A8FA-20000****</MessageId>
            <MessageBodyMD5>377AC5283D8765C9CEE4E0EA353D****</MessageBodyMD5>
        </Message>
        <Message>
            <ErrorCode>InternalError</ErrorCode>
            <ErrorMessage>Internal error.</ErrorMessage>
        </Message>
        </Messages>              

错误码

错误码错误信息HTTP状态码描述内容
QueueNotExistThe queue name you provided is not exist.404队列不存在,请先创建队列。
MalformedXMLThe XML you provided was not well-formed.400XML结构异常。
InvalidArgumentThe value of Element should between Low and High seconds/bytes.400参数值非法,请根据提示调整。
  • 本页导读 (1)
文档反馈