Granska meddelanden

  • Artikel

Åtgärden Peek Messages hämtar ett eller flera meddelanden från köns framsida, men det ändrar inte meddelandets synlighet.

Förfrågan

Du kan skapa begäran på Peek Messages följande sätt. Vi rekommenderar att du använder HTTPS. Ersätt myaccount med namnet på ditt lagringskonto och ersätt myqueue med namnet på din kö:

Metod URI för förfrågan HTTP-version
GET https://myaccount.queue.core.windows.net/myqueue/messages?peekonly=true HTTP/1.1

Emulerad lagringstjänstbegäran

När du gör en begäran mot den emulerade lagringstjänsten anger du emulatorns värdnamn och kötjänstporten som 127.0.0.1:10001följt av namnet på det emulerade lagringskontot:

Metod URI för förfrågan HTTP-version
GET http://127.0.0.1:10001/devstoreaccount1/myqueue/messages?peekonly=true HTTP/1.1

Mer information finns i Använda Azurite-emulatorn för lokal Azure Storage-utveckling.

URI-parametrar

Följande parametrar kan anges på begärande-URI:n.

Parameter Beskrivning
numofmessages Valfritt. Ett heltalsvärde som inte är noll och som anger hur många meddelanden som ska granskas från kön, upp till högst 32. Som standard granskas ett enskilt meddelande från kön med den här åtgärden.
timeout Valfritt. Parametern timeout uttrycks i sekunder. Mer information finns i Ange tidsgränser för kötjänståtgärder.

Begärandehuvuden

De obligatoriska och valfria begärandehuvudena beskrivs i följande tabell:

Begärandehuvud Beskrivning
Authorization Krävs. Anger auktoriseringsschema, kontonamn och signatur. Mer information finns i Auktorisera begäranden till Azure Storage.
Date eller x-ms-date Krävs. Anger Coordinated Universal Time (UTC) för begäran. Mer information finns i Auktorisera begäranden till Azure Storage.
x-ms-version Valfritt. Anger vilken version av åtgärden som ska användas för den här begäran. Mer information finns i Versionshantering för Azure Storage-tjänsterna.
x-ms-client-request-id Valfritt. Tillhandahåller ett klientgenererat, täckande värde med en teckengräns på 1 kibibyte (KiB) som registreras i loggarna när loggning har konfigurerats. Vi rekommenderar starkt att du använder det här huvudet för att korrelera aktiviteter på klientsidan med begäranden som servern tar emot. Mer information finns i Övervaka Azure Queue Storage.

Begärandetext

Inga.

Svarsåtgärder

Svaret innehåller en HTTP-statuskod, en uppsättning svarshuvuden och en XML-svarstext.

Statuskod

En lyckad åtgärd returnerar statuskod 200 (OK).

Mer information om statuskoder finns i Status och felkoder.

Svarshuvuden

Svaret för den här åtgärden innehåller följande rubriker. Svaret innehåller även ytterligare HTTP-standardhuvuden. Alla standardhuvuden överensstämmer med http/1.1-protokollspecifikationen.

Svarsrubrik Description
x-ms-request-id Identifierar begäran som gjordes unikt och du kan använda den för att felsöka begäran. Mer information finns i Felsöka API-åtgärder.
x-ms-version Kötjänstversionen som användes för att köra begäran. Returnerades för begäranden som gjordes mot version 2009-09-19 och senare.
Date Ett DATUM-/tidsvärde för UTC som genereras av tjänsten, vilket anger den tid då svaret initierades.
x-ms-client-request-id Kan användas för att felsöka begäranden och deras motsvarande svar. Värdet för det här huvudet är lika med värdet x-ms-client-request-id för rubriken om det finns i begäran och värdet inte innehåller fler än 1 024 synliga ASCII-tecken. Om rubriken x-ms-client-request-id inte finns i begäran finns den inte i svaret.

Själva svaret

Svars-XML för Peek Messages åtgärden returneras i följande format.

Elementet MessageID är ett GUID-värde som identifierar meddelandet i kön. Det här värdet tilldelas till meddelandet av kötjänsten och är ogenomskinlig för klienten.

Elementen InsertionTime och ExpirationTime representeras som UTC-värden och formateras enligt beskrivningen i RFC 1123.

Elementet DequeueCount har värdet 1 första gången meddelandet tas bort från kön. Det här värdet ökas varje gång meddelandet därefter tas bort från kön.

Anteckning

Elementet DequeueCount returneras endast i svarstexten om kön skapades med Queue Service version 2009-09-19.

<QueueMessagesList>  
    <QueueMessage>  
      <MessageId>string-message-id</MessageId>  
      <InsertionTime>insertion-time</InsertionTime>  
      <ExpirationTime>expiration-time</ExpirationTime>  
      <DequeueCount>integer</DequeueCount>  
      <MessageText>message-body</MessageText>  
    </QueueMessage>  
</QueueMessagesList>

Anteckning

Det här svaret skiljer sig från svaret för åtgärden Hämta meddelanden eftersom det inte innehåller elementen PopReceipt eller TimeNextVisible .

Exempelsvar

Response Status:  
HTTP/1.1 200 OK  
  
Response Headers:  
Transfer-Encoding: chunked  
Content-Type: application/xml  
Date: Fri, 16 Sep 2011 22:51:18 GMT  
Server: Windows-Azure-Queue/1.0 Microsoft-HTTPAPI/2.0  
  
Response Body:  
<?xml version="1.0" encoding="utf-8"?>  
<QueueMessagesList>  
  <QueueMessage>  
    <MessageId>06eba214-8107-4412-a7f6-710a9baff647</MessageId>  
    <InsertionTime>Fri, 09 Oct 2009 18:59:54 GMT</InsertionTime>  
    <ExpirationTime>Fri, 16 Sep 2009 18:59:54 GMT</ExpirationTime>  
    <DequeueCount>1</DequeueCount>  
    <MessageText>PHRlc3Q+dGhpcyBpcyBhIHRlc3QgbWVzc2FnZTwvdGVzdD4=</MessageText>  
  </QueueMessage>  
</QueueMessagesList>

Auktorisering

Den här åtgärden kan utföras av kontoägaren och av alla med en signatur för delad åtkomst som har behörighet att utföra den här åtgärden.

Kommentarer

När ett meddelande hämtas från kön med peekonly inställt på trueändras meddelandets synlighet. Meddelandet förblir tillgängligt för andra användare av kön tills en klient hämtar meddelandet med hjälp av åtgärden Hämta meddelanden . Klienten som begär meddelandet får inget popkvitto med svaret och kan därför inte ta bort meddelandet.

Endast meddelanden som är synliga kan hämtas med åtgärden Peek Messages . Observera att det maximala antalet meddelanden som kan hämtas är 32.

När ett meddelande hämtas för första gången med ett anrop till Get Messagesanges dess DequeueCount egenskap till 1. Om den inte tas bort och sedan hämtas igen DequeueCount ökas egenskapen. Klienten kan använda det här värdet för att avgöra hur många gånger ett meddelande har hämtats.

Anteckning

Ett anrop till Peek Messages ökar inte värdet DequeueCountför , men det returnerar det här värdet för klienten att läsa.

Om parametern numofmessages ligger inom intervallet returnerar tjänsten statuskod 400 (felaktig begäran), tillsammans med ytterligare felinformation, som du ser i följande exempel:

HTTP/1.1 400 One of the query parameters specified in the request URI is outside the permissible range.  
Connection: Keep-Alive  
Content-Length: 455  
Via: 1.1 TK5-PRXY-22  
Date: Wed, 02 May 2012 19:37:23 GMT  
Content-Type: application/xml  
Server: Windows-Azure-Queue/1.0 Microsoft-HTTPAPI/2.0  
x-ms-request-id: 6a03526c-ca2c-4358-a63a-b5d096988533  
x-ms-version: 2011-08-18  
  
<?xml version="1.0" encoding="utf-8"?>  
   <Error>  
      <Code>OutOfRangeQueryParameterValue</Code>  
      <Message>One of the query parameters specified in the request URI is outside the permissible range.  
               RequestId:6a03526c-ca2c-4358-a63a-b5d096988533  
               Time:2012-05-02T19:37:24.2438463Z  
      </Message>  
      <QueryParameterName>numofmessages</QueryParameterName>  
      <QueryParameterValue>0</QueryParameterValue>  
      <MinimumAllowed>1</MinimumAllowed>  
      <MaximumAllowed>32</MaximumAllowed>  
   </Error>

Se även

Auktorisera begäranden till Azure Storage
Status- och felkoder
Kötjänstfelkoder