キューから複数のメッセージを受信します。
認証
デフォルトでは、Alibaba Cloud アカウントのみがこの操作を呼び出すことができます。 RAM ユーザーは、関連する権限が付与された後にのみ、この操作を呼び出すことができます。次の表に、この操作の認証情報を示します。詳細については、「Permission policies and examples」をご参照ください。
名前 | 値 |
API | BatchReceiveMessage |
アクション | mns:BatchReceiveMessage |
リソース | acs:mns:$region:$accountid:/queues/$queueName/messages |
説明
この操作を呼び出して、キューから最大 16 件のメッセージを受信できます。メッセージが受信されると、メッセージは非アクティブ状態になります。メッセージは、VisibilityTimeout パラメーターで指定された期間中、非アクティブ状態のままです。詳細については、「CreateQueue」をご参照ください。
VisibilityTimeout パラメーターで指定された期間中に、メッセージを消費した後に DeleteMessage 操作を呼び出して、メッセージを削除する必要があります。そうしないと、メッセージはアクティブ状態に戻り、再度消費される可能性があります。
リクエスト
リクエストは、次の部分で構成されます。
リクエスト行
GET /queues/$queueName/messages?numOfMessages=16&waitseconds=10 HTTP/1.1操作固有の URI パラメーター
パラメーター
タイプ
必須
例
説明
numOfMessages
整数
はい
10
受信できるメッセージの最大数。
waitseconds
整数
いいえ
0
キューにメッセージがない場合にリクエストが待機する最大期間。単位:秒。
BatchReceiveMessage 操作の呼び出し時に
waitsecondsパラメーターを指定すると、リクエストは指定された期間保持されます。指定された期間中にメッセージがない場合、ロングポーリングリクエストはタイムアウトします。この期間中にキューに書き込まれたメッセージは、ユーザーにプッシュされます。 BatchReceiveMessage 操作の呼び出し時にwaitsecondsパラメーターを指定しない場合、キューに指定されているPollingWaitSecondsパラメーターがデフォルトで使用されます。詳細については、「CreateQueue」をご参照ください。同時ロングポーリングリクエストの数を減らし、適切な待機期間を指定することをお勧めします。詳細については、「ショートポーリングとロングポーリング」をご参照ください。Simple Message Queue ( SMQ 、旧称 MNS ) は、リクエスト数、リクエストの待機期間、 IP アドレスの数に基づいて、同時ロングポーリングリクエストの最大数を決定します。制限を超えると、SMQ はリクエストを保持せず、404MessageNotExist エラーを返します。この場合、リクエスト数に基づいて課金されます。制限を拡張し、不要なコストを回避するには、チケットを送信 してください。
操作固有のリクエストヘッダー
なし。
リクエスト本文
なし。
レスポンス
レスポンスは、次の部分で構成されます。
HTTP ステータスコード
HTTP/1.1 200 OK操作固有のレスポンスヘッダー
なし。
レスポンス本文
レスポンス本文は XML 形式です。複数のメッセージの本文とパラメーターが返されます。
パラメーター
タイプ
例
説明
MessageId
文字列
5F290C926D472878-2-14D9529A8FA-20000****
メッセージの ID 。メッセージ ID は、キュー内で一意です。
ReceiptHandle
文字列
1-ODU4OTkzNDU5My0xNDMyNzI3ODI3LTItOA==
メッセージの消費後に生成された受信ハンドル。メッセージの受信ハンドルを使用して、非アクティブ状態のメッセージを変更または削除できます。受信ハンドルは、NextVisibleTime パラメーターで指定された時間まで有効です。
MessageBody
文字列
This is test message 1.
メッセージの本文。
MessageBodyMD5
文字列
C5DD56A39F5F7BB8B3337C6D11B6****
メッセージ本文の MD5 ハッシュ。
EnqueueTime
Long
1250700979248
メッセージがキューに送信された時刻。この値は、エポックタイム 1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。
NextVisibleTime
Long
1250700799348
メッセージを消費できる時刻。この値は、エポックタイム 1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。
FirstDequeueTime
Long
1250700779318
メッセージが最初に消費された時刻。この値は、エポックタイム 1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。
DequeueCount
整数
1
メッセージが消費された合計回数。
例
リクエストの例
GET /queues/$queueName/messages?numOfMessages=16 HTTP/1.1
Host: $AccountId.mns.cn-hangzhou.aliyuncs.com
Date: Wed, 28 May 2012 22:32:00 GMT
x-mns-version: 2015-06-06
Authorization: MNS 15B4D3461F177624206A:xQE0diMbLRepdf3YB+FIEXA**** 成功レスポンスの例
HTTP/1.1 200 OK
Content-Type=text/xml;charset=utf-8
Content-Length:500
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>
<ReceiptHandle>1-ODU4OTkzNDU5My0xNDMyNzI3ODI3LTItOA==</ReceiptHandle>
<MessageBodyMD5>C5DD56A39F5F7BB8B3337C6D11B6****</MessageBodyMD5>
<MessageBody>This is test message 1.</MessageBody>
<EnqueueTime>1250700979248</EnqueueTime>
<NextVisibleTime>1250700799348</NextVisibleTime>
<FirstDequeueTime>1250700779318</FirstDequeueTime >
<DequeueCount>1</DequeueCount>
<Priority>8</Priority>
</Message>
<Message>
<ReceiptHandle>1-ODU4OTkzNDU5My0xNDMyNzI3MjQwLTEtOA==</ReceiptHandle>
<MessageBodyMD5>C5DD56A39F5F7BB8B3337C6D11B6****</MessageBodyMD5>
<MessageBody>This is test message 2.</MessageBody>
<EnqueueTime>1250700979252</EnqueueTime>
<NextVisibleTime>1250700799350</NextVisibleTime>
<FirstDequeueTime>1250700779330</FirstDequeueTime >
<DequeueCount>1</DequeueCount>
<Priority>8</Priority>
</Message>
</Messages> エラーコード
エラーコード | エラーメッセージ | HTTP ステータスコード | 説明 |
QueueNotExist | 指定されたキュー名は存在しません。 | 404 | 指定されたキューが存在しません。キューを作成する必要があります。 |
MessageNotExist | メッセージが存在しません。 | 404 | キューに表示可能なメッセージが存在しません。 |