VENTES: 1-800-867-1389

Peek Messages

Mis à jour: novembre 2013

Cette 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.

La demande Peek Messages peut être construite comme indiqué ci-dessous. HTTPS est recommandé. Remplacez moncompte par le nom de votre compte de stockage et myqueue par le nom de votre file d'attente :

 

Méthode URI de demande Version HTTP

GET

https://myaccount.queue.core.windows.net/myqueue/messages?peekonly=true

HTTP/1.1

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é :

 

Méthode URI de demande Version HTTP

GET

http://127.0.0.1:10001/devstoreaccount1/myqueue/messages?peekonly=true

HTTP/1.1

Pour plus d'informations, consultez About Development Storage.

Les paramètres suivants peuvent être spécifiés dans l'URI de la demande.

 

Parameter Description

numofmessages

Ce paramètre est facultatif. Une valeur entière différente de zéro qui spécifie le nombre de messages (32 au maximum) à récupérer de la file d'attente. Par défaut, cette opération ne récupère qu'un seul message de la file d'attente.

timeout

Ce paramètre est facultatif. Le paramètre timeout est exprimé en secondes. Pour plus d'informations, consultez Définition de délais d'expiration pour les opérations du service de File d'attente.

Le tableau suivant décrit les en-têtes de demande obligatoires ou facultatifs.

 

En-tête de demande Description

Authorization

Obligatoire. Spécifie le schéma d'authentification, le nom du compte et la signature. Pour plus d'informations, consultez Authentification pour les services de stockage Azure.

Date - ou - x-ms-date

Obligatoire. Spécifie le temps universel coordonné (UTC) pour la demande. Pour plus d'informations, consultez Authentification pour les services de stockage Azure.

x-ms-version

Ce paramètre est facultatif. Spécifie la version de l'opération à utiliser pour cette demande. Pour plus d'informations, consultez Contrôle de version pour les services de stockage Azure.

x-ms-client-request-id

Ce paramètre est facultatif. Fournit une valeur opaque générée par le client avec une limite de caractère de 1 Ko qui est enregistrée dans les journaux d'analyse quand la journalisation de l'analyse de stockage est activée. L'utilisation de cet en-tête est recommandée pour la corrélation des activités côté client avec les requêtes reçues par le serveur. Pour plus d'informations, consultez À propos de la journalisation Storage Analytics et Journalisation du stockage Windows Azure : utilisation des journaux pour suivre les demandes de stockage.

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.

Une opération ayant réussi retourne le code d'état 200 (OK).

Pour plus d'informations sur les codes d'état, consultez Codes d'état et codes d'erreur.

La réponse de l'opération inclut les en-têtes suivants. La réponse peut également inclure des en-têtes HTTP standard supplémentaires. Tous les en-têtes standard sont conformes à la spécification du protocole HTTP/1.1.

 

En-tête de réponse Description

x-ms-request-id

Cet en-tête identifie de façon unique la demande qui a été effectuée et peut être utilisé pour résoudre les problèmes de la demande. Pour plus d'informations, consultez Dépannage des opérations de l'API.

x-ms-version

Indique la version du service de File d'attente utilisé pour exécuter la demande. Cet en-tête est retourné pour les demandes effectuées avec la version du 19.09.09 ou ultérieure.

Date

Une valeur de date/heure UTC générée par le service qui indique le moment auquel la réponse a été initiée.

La réponse XML pour l'opération Peek Messages est retournée au format suivant.

L'élément MessageID est une valeur GUID qui identifie le message dans la file d'attente. Cette valeur est assignée au message par le service de File d'attente et est opaque au 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.

L'élément DequeueCount a une valeur de 1 la première fois que le message est dépilé. Cette valeur est incrémentée chaque fois que le message est dépilé.

noteRemarque
L'élément DequeueCount est retourné dans le corps de la réponse uniquement si la file d'attente a été créée avec la version du 19/09/2009 du service de File d'attente.

<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 pour l'opération Get Messages car la réponse ne contient pas les éléments PopReceipt ou TimeNextVisible.

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>

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.

Quand un message est récupéré de la file d'attente avec peekonly défini à true, la visibilité du message est inchangée. Le message reste disponible à d'autres utilisateurs de la file d'attente jusqu'à ce qu'un client récupère le message avec l'opération Get Messages. 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.

Seuls les messages qui sont visibles peuvent être récupérés avec l'opération Peek Messages. Notez que le nombre maximal de messages qui peuvent être récupérés est égal à 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. S'il n'est pas supprimé et qu'il est ensuite récupéré une nouvelle fois, sa propriété DequeueCount est incrémentée. Le client peut utiliser cette valeur pour déterminer combien de fois un message a été récupéré. Notez qu'un appel à Peek Messages n'augmente pas la valeur de DequeueCount, mais retourne cette valeur pour que le client puisse la lire.

Si le paramètre numofmessages est hors limites, le service retourne le code d'état 400 (Demande incorrecte), ainsi que des informations supplémentaires sur l'erreur, comme indiqué dans l'exemple suivant.

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>

Cela vous a-t-il été utile ?
(1500 caractères restants)
Merci pour vos suggestions.
Afficher:
© 2014 Microsoft