Peek MessagesPeek Messages

• 09/20/2019
• 4 minutes de lecture
• • p
  • o

L' Peek Messages opération récupère un ou plusieurs messages du début de la file d’attente, mais ne modifie pas la visibilité du message.The Peek Messages operation retrieves one or more messages from the front of the queue, but does not alter the visibility of the message.

RequêteRequest

La demande Peek Messages peut être construite comme indiqué ci-dessous.The Peek Messages request may be constructed as follows. HTTPS est recommandé.HTTPS is recommended. Remplacez moncompte par le nom de votre compte de stockage et myqueue par le nom de votre file d'attente :Replace myaccount with the name of your storage account, and myqueue with the name of your queue:

URI du service de stockage émuléEmulated storage service URI

Lorsque vous élaborez une demande pour le service de stockage émulé, spécifiez le nom d'hôte de l'émulateur et le port de service de File d'attente sous la forme 127.0.0.1:10001, suivi du nom de compte de stockage émulé :When making a request against the emulated storage service, specify the emulator hostname and Queue service port as 127.0.0.1:10001, followed by the emulated storage account name:

Paramètres URIURI Parameters

Les paramètres suivants peuvent être spécifiés dans l'URI de la demande.The following parameters may be specified on the request URI.

En-têtes de requêteRequest Headers

Le tableau suivant décrit les en-têtes de demande obligatoires ou facultatifs.The following table describes required and optional request headers.

Corps de la demandeRequest Body

Aucun.None.

responseResponse

La réponse inclut un code d'état HTTP, un ensemble d'en-têtes de réponse et un corps de réponse XML.The response includes an HTTP status code, a set of response headers, and an XML response body.

Code d’étatStatus Code

Une opération réussie envoie le code d'état 200 (OK).A successful operation returns status code 200 (OK).

Pour plus d’informations sur les codes d’État, consultez codes d’État et d’erreur.For information about status codes, see Status and Error Codes.

En-têtes de réponseResponse Headers

La réponse de l'opération inclut les en-têtes suivants.The response for this operation includes the following headers. La réponse peut également inclure des en-têtes HTTP standard supplémentaires.The response also includes additional standard HTTP headers. Tous les en-têtes standard sont conformes à la spécification du protocole HTTP/1.1.All standard headers conform to the HTTP/1.1 protocol specification.

Corps de la réponseResponse Body

La réponse XML pour l'opération Peek Messages est renvoyée au format suivant.The response XML for the Peek Messages operation is returned in the following format.

L'élément MessageID est une valeur GUID qui identifie le message dans la file d'attente.The MessageID element is a GUID value that identifies the message in the queue. Cette valeur est assignée au message par le service de File d'attente et est opaque au client.This value is assigned to the message by the Queue service and is opaque to the client.

Les éléments InsertionTime et ExpirationTime sont représentés par des valeurs UTC et mis en forme comme indiqué dans la RFC 1123.The InsertionTime and ExpirationTime elements are represented as UTC values and formatted as described in RFC 1123.

L'élément DequeueCount a une valeur de 1 la première fois que le message est dépilé.The DequeueCount element has a value of 1 the first time the message is dequeued. Cette valeur est incrémentée chaque fois que le message est dépilé.This value is incremented each time the message is subsequently dequeued.

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

Notez que cette réponse diffère de la réponse à l’opération d' extraction de messages en ce que la réponse ne contient pas les PopReceipt TimeNextVisible éléments ou.Note that this response differs from the response for the Get Messages operation in that the response does not contain the PopReceipt or TimeNextVisible elements.

Exemple de réponseSample Response

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>  

AutorisationAuthorization

Cette opération peut être exécutée par le propriétaire du compte et par toute personne qui dispose d'une signature d'accès partagé qui a l'autorisation d'exécuter cette opération.This operation can be performed by the account owner and by anyone with a shared access signature that has permission to perform this operation.

RemarquesRemarks

Quand un message est récupéré de la file d'attente avec peekonly défini à true, la visibilité du message est inchangée.When a message is retrieved from the queue with peekonly set to true, the visibility of the message is unchanged. Le message reste à la disposition des autres consommateurs de la file d’attente jusqu’à ce qu’un client récupère le message avec l’opération obtenir des messages .The message remains available to other consumers of the queue until a client retrieves the message with the Get Messages operation. Le client demandant le message ne reçoit pas d'accusé de réception pop avec la réponse et ne peut donc pas supprimer le message.The client requesting the message does not receive a pop receipt with the response and therefore cannot delete the message.

Seuls les messages qui sont visibles peuvent être récupérés avec l'opération Peek Messages.Only messages that are visible may be retrieved with the Peek Messages operation. Notez que le nombre maximal de messages qui peuvent être récupérés est égal à 32.Note that the maximum number of messages that may be retrieved is 32.

Quand un message est récupéré pour la première fois avec un appel à Get Messages, sa propriété DequeueCount est définie à 1.When a message is retrieved for the first time with a call to Get Messages, its DequeueCount property is set to 1. Si elle n'est pas supprimée et qu'elle est ensuite récupérée, la propriété DequeueCount est incrémentée.If it is not deleted and is subsequently retrieved again, the DequeueCount property is incremented. Le client peut utiliser cette valeur pour déterminer combien de fois un message a été récupéré.The client may use this value to determine how many times a message has been retrieved. Notez qu'un appel à Peek Messages n'augmente pas la valeur de DequeueCount, mais renvoie cette valeur pour que le client puisse la lire.Note that a call to Peek Messages does not increment the value of DequeueCount, but returns this value for the client to read.

Si le paramètre numofmessages est hors limites, le service renvoie le code d'état 400 (Demande incorrecte), ainsi que des informations supplémentaires sur l'erreur, comme indiqué dans l'exemple suivant.If the numofmessages parameter is out of range, the service returns status code 400 (Bad Request), along with additional error information, as shown in the following example.

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>  
  

Voir aussiSee Also

Autoriser les demandes au stockage Azure Authorize requests to Azure Storage
Codes d’État et d’erreur Status and Error Codes
Codes d’erreur de service de File d’attenteQueue Service Error Codes