Náhled zpráv

  • Článek

Operace Peek Messages načte jednu nebo více zpráv z přední části fronty, ale nezmění viditelnost zprávy.

Žádost

Požadavek můžete sestavit Peek Messages následujícím způsobem. Doporučujeme používat protokol HTTPS. Nahraďte myaccount názvem vašeho účtu úložiště a myqueue nahraďte názvem vaší fronty:

Metoda Identifikátor URI žádosti Verze PROTOKOLU HTTP
GET https://myaccount.queue.core.windows.net/myqueue/messages?peekonly=true HTTP/1.1

Žádost o službu emulovaného úložiště

Když vytváříte požadavek na službu emulovaného úložiště, zadejte název hostitele emulátoru a port služby fronty jako 127.0.0.1:10001a za ním název emulovaného účtu úložiště:

Metoda Identifikátor URI žádosti Verze PROTOKOLU HTTP
GET http://127.0.0.1:10001/devstoreaccount1/myqueue/messages?peekonly=true HTTP/1.1

Další informace najdete v tématu Použití emulátoru Azurite pro vývoj v místním úložišti Azure Storage.

Parametry identifikátoru URI

V identifikátoru URI požadavku je možné zadat následující parametry.

Parametr Popis
numofmessages Nepovinný parametr. Nenulová celočíselná hodnota, která určuje počet zpráv, které se mají z fronty zobrazit, maximálně 32. Ve výchozím nastavení se z fronty pomocí této operace zobrazí náhled jedné zprávy.
timeout Nepovinný parametr. Parametr se timeout vyjadřuje v sekundách. Další informace najdete v tématu Nastavení časových limitů pro operace služby Fronta.

Hlavičky požadavku

Požadované a volitelné hlavičky požadavků jsou popsané v následující tabulce:

Hlavička požadavku Popis
Authorization Povinná hodnota. Určuje schéma autorizace, název účtu a podpis. Další informace najdete v tématu Autorizace požadavků do služby Azure Storage.
Date nebo x-ms-date Povinná hodnota. Určuje formát UTC (Coordinated Universal Time). Další informace najdete v tématu Autorizace požadavků do služby Azure Storage.
x-ms-version Nepovinný parametr. Určuje verzi operace, která se má pro tento požadavek použít. Další informace najdete v tématu Správa verzí pro služby Azure Storage.
x-ms-client-request-id Nepovinný parametr. Poskytuje klientem vygenerovanou neprůselnou hodnotu s limitem počtu znaků 1 kibibajt (KiB), který je zaznamenán v protokolech při konfiguraci protokolování. Důrazně doporučujeme použít tuto hlavičku ke korelaci aktivit na straně klienta s požadavky, které server přijímá. Další informace najdete v tématu Monitorování služby Azure Queue Storage.

Text požadavku

Žádné

Odpověď

Odpověď obsahuje stavový kód HTTP, sadu hlaviček odpovědi a tělo odpovědi XML.

Stavový kód

Úspěšná operace vrátí stavový kód 200 (OK).

Další informace o stavových kódech najdete v tématu Kódy stavu a chyb.

Hlavičky odpovědi

Odpověď na tuto operaci obsahuje následující hlavičky. Odpověď obsahuje také další standardní hlavičky HTTP. Všechny standardní hlavičky odpovídají specifikaci protokolu HTTP/1.1.

Hlavička odpovědi Description
x-ms-request-id Jednoznačně identifikuje požadavek, který byl proveden, a můžete ho použít k řešení potíží s požadavkem. Další informace najdete v tématu Řešení potíží s operacemi rozhraní API.
x-ms-version Verze frontové služby, která se použila ke spuštění požadavku. Vráceno pro žádosti, které byly provedeny proti verzi 2009-09-19 a novější.
Date Hodnota data a času UTC vygenerovaná službou, která označuje čas, kdy byla odpověď inicializována.
x-ms-client-request-id Dá se použít k řešení potíží s požadavky a jejich odpovídajícími odpověďmi. Hodnota této hlavičky se rovná hodnotě x-ms-client-request-id hlavičky, pokud se nachází v požadavku, a hodnota obsahuje maximálně 1 024 viditelných znaků ASCII. Pokud se hlavička x-ms-client-request-id v požadavku nenachází, v odpovědi se nezobrazí.

Text odpovědi

Kód XML odpovědi na Peek Messages operaci se vrátí v následujícím formátu.

Element MessageID je hodnota GUID, která identifikuje zprávu ve frontě. Tato hodnota je přiřazena ke zprávě službou Queue a je pro klienta neprůžná.

Prvky InsertionTime a ExpirationTime jsou reprezentovány jako hodnoty UTC a formátovány podle popisu v DOKUMENTU RFC 1123.

Element DequeueCount má hodnotu 1 při prvním vyřazení zprávy z fronty. Tato hodnota se při každém následném vyřazení zprávy z fronty navýší.

Poznámka

Element DequeueCount se vrátí v textu odpovědi pouze v případě, že fronta byla vytvořena pomocí queue service verze 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>

Poznámka

Tato odpověď se liší od odpovědi na operaci Získat zprávy tím, že neobsahuje elementy PopReceipt nebo TimeNextVisible .

Ukázková odpověď

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>

Autorizace

Tuto operaci může provést vlastník účtu a kdokoli se sdíleným přístupovým podpisem, který má oprávnění k provedení této operace.

Poznámky

Když se z fronty načte zpráva s nastavenou peekonly na true, viditelnost zprávy se nezmění. Zpráva zůstane k dispozici ostatním příjemcům fronty, dokud klient nenačte zprávu pomocí operace Získat zprávy . Klient, který zprávu požaduje, neobdrží potvrzení pop s odpovědí, a proto nemůže zprávu odstranit.

Pomocí operace lze načíst Peek Messages pouze zprávy, které jsou viditelné. Všimněte si, že maximální počet zpráv, které lze načíst, je 32.

Při prvním načtení zprávy voláním Get Messagesmetody je její DequeueCount vlastnost nastavena na hodnotu 1. Pokud se neodstraní a následně se znovu načte, DequeueCount vlastnost se navýší. Klient může tuto hodnotu použít k určení, kolikrát byla zpráva načtena.

Poznámka

Volání Peek Messages nezvyšuje hodnotu DequeueCount, ale vrátí tuto hodnotu, aby ji klient načetl.

Pokud je parametr numofmessages mimo rozsah, vrátí služba stavový kód 400 (Chybný požadavek) spolu s dalšími informacemi o chybě, jak je znázorněno v následujícím příkladu:

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>

Viz také

Autorizace požadavků do Služby Azure Storage
Stavové kódy a kódy chyb
Kódy chyb služby Queue Service