Delen via

Berichten bekijken

  • Artikel

Met Peek Messages de bewerking worden een of meer berichten aan de voorzijde van de wachtrij opgehaald, maar de zichtbaarheid van het bericht wordt niet gewijzigd.

Aanvraag

U kunt de Peek Messages aanvraag als volgt samenstellen. U wordt aangeraden HTTPS te gebruiken. Vervang myaccount door de naam van uw opslagaccount en vervang myqueue door de naam van uw wachtrij:

Methode Aanvraag-URI HTTP-versie
GET https://myaccount.queue.core.windows.net/myqueue/messages?peekonly=true HTTP/1.1

Aanvraag voor geëmuleerde opslagservice

Wanneer u een aanvraag indient voor de geëmuleerde opslagservice, geeft u de hostnaam van de emulator en de wachtrijservicepoort op als 127.0.0.1:10001, gevolgd door de naam van het geëmuleerde opslagaccount:

Methode Aanvraag-URI HTTP-versie
GET http://127.0.0.1:10001/devstoreaccount1/myqueue/messages?peekonly=true HTTP/1.1

Zie Use the Azurite emulator for local Azure Storage development (De Azurite-emulator gebruiken voor lokale Azure Storage-ontwikkeling) voor meer informatie.

URI-parameters

De volgende parameters kunnen worden opgegeven voor de aanvraag-URI.

Parameter Beschrijving
numofmessages Optioneel. Een niet-nul gehele waarde die het aantal berichten aangeeft dat uit de wachtrij moet worden weergegeven, tot een maximum van 32. Standaard wordt met deze bewerking één bericht uit de wachtrij bekeken.
timeout Optioneel. De timeout parameter wordt uitgedrukt in seconden. Zie Time-outs instellen voor wachtrijservicebewerkingen voor meer informatie.

Aanvraagheaders

De vereiste en optionele aanvraagheaders worden beschreven in de volgende tabel:

Aanvraagheader Beschrijving
Authorization Vereist. Hiermee geeft u het autorisatieschema, de accountnaam en de handtekening. Zie Aanvragen voor Azure Storage autoriseren voor meer informatie.
Date of x-ms-date Vereist. Geef de Coordinated Universal Time (UTC) op voor de aanvraag. Zie Aanvragen voor Azure Storage autoriseren voor meer informatie.
x-ms-version Optioneel. Hiermee geeft u de versie van de bewerking te gebruiken voor deze aanvraag. Zie Versiebeheer voor de Azure Storage-services voor meer informatie.
x-ms-client-request-id Optioneel. Biedt een door de client gegenereerde, ondoorzichtige waarde met een limiet van 1 kibibyte (KiB) die wordt vastgelegd in de logboeken wanneer logboekregistratie is geconfigureerd. We raden u ten zeerste aan deze header te gebruiken om activiteiten aan de clientzijde te correleren met aanvragen die de server ontvangt. Zie Azure Queue Storage bewaken voor meer informatie.

Aanvraagbody

Geen.

Antwoord

Het antwoord bevat een HTTP-statuscode, een set antwoordheaders en een XML-antwoordtekst.

Statuscode

Een geslaagde bewerking retourneert statuscode 200 (OK).

Zie Status- en foutcodes voor meer informatie over statuscodes.

Antwoordheaders

Het antwoord voor deze bewerking bevat de volgende headers. Het antwoord bevat ook aanvullende standaard-HTTP-headers. Alle standaardheaders voldoen aan de HTTP/1.1-protocolspecificatie.

Antwoordheader Beschrijving
x-ms-request-id Identificeert op unieke wijze de aanvraag die is gedaan en u kunt deze gebruiken om problemen met de aanvraag op te lossen. Zie Problemen met API-bewerkingen oplossen voor meer informatie.
x-ms-version De queue-serviceversie die is gebruikt om de aanvraag uit te voeren. Geretourneerd voor aanvragen die zijn gemaakt op basis van versie 2009-09-19 en hoger.
Date Een UTC-datum/tijd-waarde die wordt gegenereerd door de service, die de tijd aangeeft waarop het antwoord is gestart.
x-ms-client-request-id Kan worden gebruikt om problemen met aanvragen en de bijbehorende antwoorden op te lossen. De waarde van deze header is gelijk aan de waarde van de x-ms-client-request-id header als deze aanwezig is in de aanvraag en de waarde niet meer dan 1024 zichtbare ASCII-tekens bevat. Als de x-ms-client-request-id header niet aanwezig is in de aanvraag, is deze niet aanwezig in het antwoord.

Hoofdtekst van de reactie

De antwoord-XML voor de Peek Messages bewerking wordt geretourneerd in de volgende indeling.

Het MessageID element is een GUID-waarde die het bericht in de wachtrij identificeert. Deze waarde wordt door de Queue-service toegewezen aan het bericht en is ondoorzichtig voor de client.

De InsertionTime elementen en ExpirationTime worden weergegeven als UTC-waarden en opgemaakt zoals beschreven in RFC 1123.

Het DequeueCount element heeft de waarde 1 wanneer het bericht voor het eerst uit de wachtrij wordt verwijderd. Deze waarde wordt verhoogd telkens wanneer het bericht vervolgens uit de wachtrij wordt verwijderd.

Notitie

Het DequeueCount element wordt alleen geretourneerd in de antwoordtekst als de wachtrij is gemaakt met Queue Service versie 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>

Notitie

Dit antwoord verschilt van het antwoord voor de bewerking Berichten ophalen omdat het de elementen of TimeNextVisible niet bevatPopReceipt.

Voorbeeldantwoord

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>

Autorisatie

Deze bewerking kan worden uitgevoerd door de accounteigenaar en door iedereen met een shared access signature die gemachtigd is om deze bewerking uit te voeren.

Opmerkingen

Wanneer een bericht wordt opgehaald uit de wachtrij met peekonly ingesteld op true, blijft de zichtbaarheid van het bericht ongewijzigd. Het bericht blijft beschikbaar voor andere gebruikers van de wachtrij totdat een client het bericht ophaalt met behulp van de bewerking Berichten ophalen . De client die het bericht aanvraagt, ontvangt geen pop-ontvangstbevestiging met het antwoord en kan het bericht daarom niet verwijderen.

Alleen berichten die zichtbaar zijn, kunnen worden opgehaald met de Peek Messages bewerking. Houd er rekening mee dat het maximum aantal berichten dat kan worden opgehaald, 32 is.

Wanneer een bericht voor het eerst wordt opgehaald met een aanroep naar Get Messages, wordt de DequeueCount eigenschap ingesteld op 1. Als deze niet wordt verwijderd en vervolgens opnieuw wordt opgehaald, wordt de DequeueCount eigenschap verhoogd. De client kan deze waarde gebruiken om te bepalen hoe vaak een bericht is opgehaald.

Notitie

Met een aanroep naar Peek Messages wordt de waarde van DequeueCountniet verhoogd, maar wordt deze waarde geretourneerd zodat de client deze kan lezen.

Als de parameter numofmessages buiten het bereik valt, retourneert de service statuscode 400 (Ongeldige aanvraag), samen met aanvullende foutinformatie, zoals wordt weergegeven in het volgende voorbeeld:

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>

Zie ook

Aanvragen voor Azure Storage autoriseren
Status en foutcodes
Foutcodes voor wachtrijservice