List Queues
Cet article a fait l'objet d'une traduction automatique. Déplacez votre pointeur sur les phrases de l'article pour voir la version originale de ce texte. Informations supplémentaires.
Traduction
Source

List Queues

 

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

Le List Queues demande peut être construite comme suit. HTTPS est recommandé. Remplacez myaccount avec 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 auprès du service de stockage émulé, spécifiez le nom d'hôte de l'émulateur et le port de service de file d'attente en tant que 127.0.0.1:10001, suivie 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

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

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 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 à renvoyer. Si maxresults n'est pas spécifié, le serveur retourne jusqu'à 5 000 éléments.

include=metadata

Facultatif. 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 d'attribution de noms imposées par la version du 19/09/2009 du service de File d'attente. À compter de cette version, tous les noms de métadonnées doivent respecter les conventions d'affectation de noms de identificateurs c#.

timeout

Facultatif. Le timeout paramètre 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 Azure Storage.

Masquer ou restaurer les mises à jour

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

x-ms-version

Facultatif. Spécifie la version de l'opération à utiliser pour cette demande. Pour plus d'informations, consultez Contrôle de version des services BLOB, de File d'attente et de Table dans Windows Azure.

x-ms-client-request-id

Facultatif. Fournit une valeur opaque générée par le client avec une limite de caractère de 1 Ko enregistrée dans les journaux d'analyse lorsque la journalisation de l'analyse de stockage est activée. L'utilisation de cet en-tête est fortement recommandée pour une corrélation des activités du 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 Azure : à l'aide de 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 réussie envoie le code d'état 200 (OK).

Pour plus d'informations sur les codes d'état, consultez Codes d'état et 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 renvoyé 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 le Prefix, Marker, et MaxResults éléments sont uniquement présents s'ils ont été spécifiés dans l'URI. Le NextMarker élément a une valeur uniquement si les résultats de liste ne sont pas terminées.

Pour la version 2013-08-15 et versions ultérieures, le AccountName d'attribut pour le EnumerationResults élément a été renommé ServiceEndpoint. En outre, le Url élément 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>

Le Metadata l'élément est présent uniquement si le include=metadata paramètre a été spécifié dans l'URI. Dans la Metadata élément, 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'affectation de noms appliquées par la version 2009-09-19, le corps de réponse indique le nom problématique dans un x-ms-invalid-name élément, 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 maxresults paramètre et le nombre de files d'attente à renvoyer dépasse cette valeur, ou dépasse la valeur par défaut maxresults, le corps de la réponse contient un NextMarker élément indiquant que la file d'attente suivante à retourner dans une demande suivante. Pour renvoyer l'ensemble suivant d'éléments, spécifiez la valeur de NextMarker en tant que paramètre de marqueur dans l'URI de 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 à renvoyer 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 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 le NextMarker élément 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 suivant de résultats est renvoyé 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>
Afficher:
© 2016 Microsoft