Clear Messages
Clear Messages 操作は、指定されたキューからすべてのメッセージを削除します。
Request
要求は Clear Messages 次のように構築できます。 HTTPS をお勧めします。 myaccount をストレージ アカウントの名前に置き換え、myqueue をキューの名前に置き換えます。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
DELETE |
https://myaccount.queue.core.windows.net/myqueue/messages |
HTTP/1.1 |
エミュレートされたストレージ サービスの URI
エミュレートされたストレージ サービスに対して要求を行う場合は、エミュレーター ホスト名と Azure Queue Storage ポートを として 127.0.0.1:10001指定し、その後にエミュレートされたストレージ アカウントの名前を指定します。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
DELETE |
http://127.0.0.1:10001/devstoreaccount1/myqueue/messages |
HTTP/1.1 |
URI パラメーター
次の追加パラメーターを要求 URI に指定できます。
| パラメーター | 説明 |
|---|---|
timeout |
任意。 timeout パラメーターは、秒単位で表されます。 詳細については、「 キュー ストレージ操作のタイムアウトを設定する」を参照してください。 |
要求ヘッダー
次の表では、必須および省略可能な要求ヘッダーについて説明します。
| 要求ヘッダー | 説明 |
|---|---|
Authorization |
必須。 承認スキーム、アカウント名、署名を指定します。 詳細については、「Azure Storage への要求を承認する」をご覧ください。 |
Date または x-ms-date |
必須。 要求に対して協定世界時 (UTC) を指定します。 詳細については、「Azure Storage への要求を承認する」をご覧ください。 |
x-ms-version |
任意。 この要求に使用する操作のバージョンを指定します。 詳細については、「Azure Storage サービスのバージョン管理」を参照してください。 |
x-ms-client-request-id |
任意。 ログ記録の構成時にログに記録される 1 kibibyte (KiB) 文字制限を使用して、クライアントによって生成された不透明な値を提供します。 このヘッダーを使用して、クライアント側のアクティビティとサーバーが受信する要求を関連付けるよう強くお勧めします。 |
要求本文
[なし] :
Response
応答には、HTTP 状態コードおよび一連の応答ヘッダーが含まれています。
状態コード
操作が正常に終了すると、ステータス コード 204 (No Content) が返されます。
状態コードの詳細については、「 状態とエラー コード」を参照してください。
応答ヘッダー
この操作の応答には、次のヘッダーが含まれています。 応答には追加の標準 HTTP ヘッダーも含まれます。 すべての標準ヘッダーは 、HTTP/1.1 プロトコル仕様に準拠しています。
| 要求ヘッダー | 説明 |
|---|---|
x-ms-request-id |
行われた要求を一意に識別します。 このヘッダーを使用して、要求のトラブルシューティングを行うことができます。 詳細については、「 API 操作のトラブルシューティング」を参照してください。 |
x-ms-version |
要求の実行に使用される Queue Storage のバージョンを示します。 このヘッダーはバージョン 2009-09-19 以降で行った要求に対して返されます。 |
Date |
サービスが応答を送信した時刻を示す UTC 日付/時刻値。 |
x-ms-client-request-id |
要求と対応する応答のトラブルシューティングに使用できます。 このヘッダーの値は、要求に存在し、その値が最大 1,024 文字の可視 ASCII 文字である場合、ヘッダーの値 x-ms-client-request-id と等しくなります。 ヘッダーが x-ms-client-request-id 要求に存在しない場合、このヘッダーは応答に存在しません。 |
応答本文
[なし] :
承認
この操作を呼び出すことができるのは、アカウント所有者だけです。
解説
キューに多数のメッセージが含まれている場合は、 Clear Messages すべてのメッセージが削除される前にタイムアウトになる可能性があります。 この場合、Queue Storage は状態コード 500 (内部サーバー エラー) を返し、追加のエラー コード OperationTimedOut が返されます。 このエラー コードを受け取った場合、サーバー側で操作が成功した可能性があり、操作を再試行する前にサーバーの状態を照会する必要があります。 操作がタイムアウトし、サーバー側で失敗したと判断された場合、クライアントは成功するまで再試行 Clear Messages を続け、すべてのメッセージが削除されていることを確認する必要があります。