VENTES: 1-800-867-1389

List Queues

Mis à jour: novembre 2013

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

La demande List Queues peut être construite comme indiqué ci-dessous. HTTPS est recommandé. Remplacez moncompte 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

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?comp=list

HTTP/1.1

Pour plus d'informations, consultez About Development Storage.

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

 

Parameter Description

prefix

Filtre les résultats afin de ne retourner 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 élément NextMarker dans le corps de la réponse si la liste retournée n'était pas terminée. Cette valeur peut ensuite être utilisée 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 à retourner. Si maxresults n'est pas spécifié, le serveur retourne jusqu'à 5 000 éléments.

include=metadata

Ce paramètre est facultatif. Indiquez ce paramètre pour spécifier que les métadonnées du conteneur sont retourné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 d'attribution de noms imposées par la version du 19/09/2009 du service de File d'attente. À partir de cette version, tous les noms de métadonnées doivent respecter les conventions d'affectation de noms pour les identificateurs C#.

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.

Consultez la section Exemple de demande et de réponse ci-dessous pour un exemple de demande.

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.

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 aussi 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/2009 et 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.

Le format du corps de la réponse se présente comme suit. Notez que les éléments Prefix, Marker et MaxResults sont uniquement présents s'ils ont été spécifiés dans l'URI. L'élément NextMarker a une valeur uniquement si les résultats de liste ne sont pas terminés.

Pour la version du 15/08/2013 et les versions ultérieures, l'attribut AccountName de l'élément EnumerationResults a été renommé ServiceEndpoint. 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>
      …

Consultez la section Exemple de demande et de réponse ci-dessous pour un exemple de réponse.

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

Si vous spécifiez une valeur pour le paramètre maxresults et que le nombre de files d'attente à renvoyer dépasse cette valeur, ou dépasse la valeur par défaut pour maxresults, le corps de la réponse contient un élément NextMarker qui indique la file d'attente suivante à retourner dans une demande suivante. Pour retourner 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.

L'exemple d'URI suivant demande la liste des files d'attente pour un compte, en définissant les résultats maximum à retourner pour l'opération initiale à 3.

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 retourné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 de files d'attente et comprend le nom de la file d'attente suivante à renvoyer.

<?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 suivant de résultats 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>

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