Lister les files d’attente

Article
06/27/2023

Cette opération répertorie toutes les files d’attente dans un compte de stockage particulier.

Requête

Vous pouvez construire la List Queues requête comme suit. HTTPS est recommandé. Remplacez myaccount par le nom de votre compte de stockage.

Méthode	URI de demande	Version HTTP
`GET`	`https://myaccount.queue.core.windows.net?comp=list`	HTTP/1.1

URI du service de stockage émulé

Lorsque vous effectuez une demande auprès du service de stockage émulé, spécifiez le nom d’hôte de l’émulateur et le port de stockage File d’attente Azure en tant que 127.0.0.1:10001, suivis du nom du compte de stockage émulé.

Méthode	URI de demande	Version HTTP
`GET`	`http://127.0.0.1:10001/devstoreaccount1?comp=list`	HTTP/1.1

Paramètres URI

Vous pouvez spécifier les paramètres supplémentaires suivants sur l’URI de requête.

Paramètre	Description
`prefix`	Filtre les résultats afin de ne renvoyer que les files d'attente dont les noms commencent par le préfixe spécifié.
`marker`	Valeur de chaîne qui identifie la partie de la liste à renvoyer avec l'opération de liste suivante. L’opération retourne un `NextMarker` élément dans le corps de la réponse, si la liste retournée n’était pas complète. Vous pouvez ensuite utiliser cette valeur comme paramètre de requête dans un appel suivant pour demander la partie suivante de la liste des files d’attente. La valeur de marqueur est opaque au client.
`maxresults`	Indique le nombre maximal de files d'attente à renvoyer. Si `maxresults` n’est pas spécifié, le serveur retourne jusqu’à 5 000 éléments.
`include=metadata`	Optionnel. Indiquez ce paramètre pour spécifier que les métadonnées du conteneur sont renvoyées dans le corps de la réponse. Notez que les métadonnées demandées avec ce paramètre doivent être stockées conformément aux restrictions de nommage imposées par la version 2009-09-19 de Stockage File d’attente. À compter de cette version, tous les noms de métadonnées doivent respecter les conventions d’affectation de noms pour les identificateurs C#.
`timeout`	Optionnel. Le paramètre `timeout` est exprimé en secondes. Pour plus d’informations, consultez Définition des délais d’expiration pour les opérations de stockage file d’attente.

En-têtes de requête

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

En-tête de requête	Description
`Authorization`	Obligatoire. Spécifie le schéma d’autorisation, le nom du compte et la signature. Pour plus d’informations, consultez Autoriser les requêtes auprès du Stockage Azure.
`Date` ou `x-ms-date`	Obligatoire. Spécifie la date/heure en temps universel coordonné (UTC) pour la requête. Pour plus d’informations, consultez Autoriser les requêtes auprès du Stockage Azure.
`x-ms-version`	Optionnel. Spécifie la version de l'opération à utiliser pour cette demande. Pour plus d'informations, consultez la page Contrôle de version pour les services de Stockage Microsoft Azure.
`x-ms-client-request-id`	Optionnel. Fournit une valeur opaque générée par le client avec une limite de caractères de 1 kibioctet (Kio) enregistrée dans les journaux lors de la configuration de la journalisation. Nous vous recommandons vivement d’utiliser cet en-tête pour mettre en corrélation les activités côté client avec les demandes que le serveur reçoit. Pour plus d’informations, consultez Surveiller le stockage File d’attente Azure.

Corps de la demande

Aucun.

Exemple de requête

Reportez-vous à la section « Exemple de demande et de réponse » plus loin dans cet article.

response

La réponse comprend un code d'état HTTP, un ensemble d'en-têtes de réponse et un corps de réponse contenant la liste des files d'attente.

Code d’état

Une opération réussie envoie le code d'état 200 (OK). Pour plus d’informations sur les codes status, consultez Codes d’état et d’erreur.

En-têtes de réponse

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 manière unique la requête qui a été effectuée et peut être utilisé pour la résolution des problèmes de la demande. Pour plus d’informations, consultez Résolution des problèmes liés aux opérations d’API.
`x-ms-version`	Indique la version du stockage file d’attente utilisée pour exécuter la requête. Cet en-tête est renvoyé pour les demandes effectuées avec la version 2009-09-19 ou une version ultérieure.
`Date`	Valeur de date/heure UTC qui indique l’heure à laquelle la réponse a été lancée. Le service génère cette valeur.
`x-ms-client-request-id`	Vous pouvez utiliser cet en-tête pour résoudre les problèmes liés aux demandes et aux réponses correspondantes. La valeur de cet en-tête est égale à la valeur de l’en-tête `x-ms-client-request-id` , s’il est présent dans la requête. La valeur est au maximum de 1 024 caractères ASCII visibles. Si l’en-tête `x-ms-client-request-id` n’est pas présent dans la demande, cet en-tête ne sera pas présent dans la réponse.

Response body

Le format du corps de la réponse est le suivant. Notez que les Prefixéléments , Markeret MaxResults ne sont présents que si vous les avez spécifiés sur l’URI. L’élément NextMarker a une valeur uniquement si les résultats de la liste ne sont pas terminés.

Pour les versions 2013-08-15 et ultérieures, l’attribut AccountName de l’élément EnumerationResults a été renommé ServiceEndpointen . En outre, l'élément Url sous Queue a été supprimé.

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults ServiceEndpoint="https://myaccount.queue.core.windows.net/">  
  <Prefix>string-value</Prefix>  
  <Marker>string-value</Marker>  
  <MaxResults>int-value</MaxResults>  
  <Queues>  
    <Queue>  
      <Name>string-value</Name>  
      <Metadata>  
      <metadata-name>value</metadata-name>  
    <Metadata>  
    </Queue>  
  <NextMarker />  
</EnumerationResults>

L'élément Metadata peut être présent uniquement si le paramètre include=metadata a été spécifié dans l'URI. Dans l'élément Metadata, la valeur de chaque paire nom-valeur est indiquée dans un élément correspondant au nom de la paire.

Si une paire nom-valeur de métadonnées viole les restrictions d'attribution de noms imposées par la version du 19/09/2009, le corps de la réponse indique le nom problématique dans un élément x-ms-invalid-name, comme indiqué dans le fragment XML suivant :

  
…  
<Metadata>  
  <MyMetadata1>first value</MyMetadata1>  
  <MyMetadata2>second value</MyMetadata2>  
  <x-ms-invalid-name>invalid-metadata-name</x-ms-invalid-name>  
<Metadata>  
…

Exemple de réponse

Reportez-vous à la section « Exemple de demande et de réponse » plus loin dans cet article.

Autorisation

Seul le propriétaire du compte peut appeler cette opération.

Notes

Si vous spécifiez une valeur pour le maxresults paramètre et que le nombre de files d’attente à retourner dépasse cette valeur, ou dépasse la valeur par défaut pour maxresults, le corps de la réponse contient un NextMarker élément. Cet élément indique la file d’attente suivante à retourner lors d’une demande suivante. Pour renvoyer l'ensemble suivant d'éléments, spécifiez la valeur de NextMarker comme paramètre de marqueur dans l'URI pour la demande suivante.

Notez que la valeur de NextMarker doit être traitée comme opaque.

Les files d'attente sont répertoriées par ordre alphabétique dans le corps de la réponse.

Exemple de requête et de réponse

Voici un exemple d’URI qui demande la liste des files d’attente d’un compte. Il définit le nombre maximal de résultats à retourner pour l’opération initiale sur trois.

GET https://myaccount.queue.core.windows.net?comp=list&maxresults=3&include=metadata HTTP/1.1

La demande est envoyée avec ces en-têtes :

x-ms-version: 2013-08-15  
x-ms-date: Wed, 23 Oct 2013 00:55:16 GMT  
Authorization: SharedKey myaccount:Q7tar7qqM2LD/Wey7OQNPP3hMNap9wjg+g9AlAYeFls=

Le code d'état et les en-têtes de réponse sont renvoyés comme suit :

HTTP/1.1 200 OK  
Transfer-Encoding: chunked  
Content-Type: application/xml  
Date: Wed, 23 Oct 2013 00:56:38 GMT  
x-ms-version: 2013-08-15  
Server: Windows-Azure-Queue/1.0 Microsoft-HTTPAPI/2.0

Le code XML de réponse pour cette demande est le suivant : Notez que l’élément NextMarker suit l’ensemble des files d’attente et inclut le nom de la file d’attente suivante à retourner.

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults ServiceEndpoint="https://myaccount.queue.core.windows.net/">  
  <Prefix>q</Prefix>  
  <MaxResults>3</MaxResults>  
  <Queues>  
    <Queue>  
      <Name>q1</Name>  
      <Metadata>  
        <Color>red</Color>  
        <SomeMetadataName>SomeMetadataValue</SomeMetadataName>  
      <Metadata>  
    </Queue>  
    <Queue>  
      <Name>q2</Name>  
      <Metadata>  
        <Color>blue</Color>  
        <SomeMetadataName>SomeMetadataValue</SomeMetadataName>  
      <Metadata>  
    </Queue>  
    <Queue>  
      <Name>q3</Name>  
      <Metadata>  
        <Color>yellow</Color>  
        <SomeMetadataName>SomeMetadataValue</SomeMetadataName>  
      <Metadata>  
    </Queue>  
  </Queues>  
  <NextMarker>q4</NextMarker>  
</EnumerationResults>

L'opération de liste suivante spécifie le marqueur dans l'URI de la demande, comme suit. L’ensemble de résultats suivant est retourné, en commençant par la file d’attente spécifiée par le marqueur. Voici l'URI pour la demande suivante :

https://myaccount.queue.core.windows.net?comp=list&maxresults=3&include=metadata&prefix=q&marker=q4

Le corps de la réponse pour cette opération est le suivant :

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults ServiceEndpoint="https://myaccount.queue.core.windows.net/">  
  <Prefix>q</Prefix>  
  <Marker>q4</Marker>  
  <MaxResults>3</MaxResults>  
  <Queues>  
    <Queue>  
      <Name>q4</Name>  
      <Metadata>  
        <Color>green</Color>  
        <SomeMetadataName>SomeMetadataValue</SomeMetadataName>  
      <Metadata>  
    </Queue>  
    <Queue>  
      <Name>q5</Name>  
      <Metadata>  
        <Color>violet</Color>  
        <SomeMetadataName>SomeMetadataValue</SomeMetadataName>  
      <Metadata>  
    </Queue>  
  </Queues>  
  <NextMarker />  
</EnumerationResults>

Voir aussi

Autoriser les demandes dans le Stockage Azure
Codes d’état et d’erreur
Codes d’erreur de stockage de file d’attente