一度に複数のメッセージをキューに送信します。
認証情報
デフォルトでは、Alibaba Cloud アカウントのみがこのオペレーションを呼び出すことができます。 RAM ユーザーは、関連する権限が付与された後にのみ、このオペレーションを呼び出すことができます。次の表に、このオペレーションの認証情報を示します。詳細については、「権限ポリシーと例」をご参照ください。
名前 | 値 |
API | BatchSendMessage |
アクション | mns:BatchSendMessage |
リソース | acs:mns:$region:$accountid:/queues/$queueName/messages |
使用上の注意
この操作を呼び出して、一度に最大 16 件のメッセージをキューに送信できます。一度に送信できるメッセージの最大サイズは 64 KB です。キューにメッセージを送信するときに DelaySeconds パラメーターを指定しない場合、メッセージはすぐに消費されます。メッセージを定期的に消費する場合は、メッセージをキューに送信するときに
DelaySecondsパラメーターを指定できます。DelaySecondsパラメーターを 0 より大きい値に設定すると、メッセージがキューに送信された後、メッセージは遅延状態になります。DelaySecondsパラメーターで指定された期間が終了し、メッセージのステータスがアクティブに変更されるまで、メッセージは消費できません。メッセージのDelaySecondsパラメーターの値が、キューのDelaySecondsパラメーターの値と異なる場合、メッセージのDelaySecondsパラメーターの値が有効になります。BatchSendMessage オペレーションを呼び出す場合、QPS は 1 秒あたりのクエリ数(QPS)とメッセージ数の積に等しくなります。 BatchSendMessage オペレーションを呼び出して 10 件のメッセージを送信し、QPS が 100 であると仮定すると、単一キューの QPS は 100 × 10 = 1000 に等しくなります。
この API オペレーションを呼び出してメッセージを送信する前に、Base64 を使用してメッセージ本文をエンコードします。これにより、特殊文字による予期しないエラーを防ぎます。
リクエスト
リクエストは次の部分で構成されます。
リクエスト行
POST /queues/$queueName/messages HTTP/1.1オペレーション固有のリクエストヘッダー
なし。
リクエストボディ
リクエストボディは XML 形式です。複数のメッセージのパラメーターがリクエストボディに含まれています。
パラメーター
タイプ
必須
例
説明
MessageBody
String
はい
This is test message 1.
メッセージの本文。
DelaySeconds
Integer
いいえ
60
キューに送信されたメッセージが消費されるまでの遅延時間。
有効な値:0 ~ 604800。単位:秒。
デフォルト値:0。
レスポンス
レスポンスは次の部分で構成されます。
HTTP ステータスコード
HTTP/1.1 201 Createdオペレーション固有のレスポンスヘッダー
なし。
レスポンスボディ
レスポンスボディは XML 形式です。複数のメッセージの MessageId パラメーターと MessageBodyMD5 パラメーターが返されます。
パラメーター
タイプ
例
説明
MessageId
String
5F290C926D472878-2-14D9529A8FA-20000****
メッセージの ID。メッセージ ID はキュー内で一意です。
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 ステータスコード | 説明 |
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 | パラメーターの値が無効なため返されるエラーメッセージです。指示に従って有効な値を指定する必要があります。 |