Obtention de métadonnées file d'attente

  • Article

L'opération Get Queue Metadata extrait les métadonnées définies par l'utilisateur et les propriétés de file d'attente dans la file d'attente spécifiée. Les métadonnées sont associées à la file d'attente en tant que paires nom-valeur.

Requête

La demande Get Queue Metadata peut être construite comme indiqué ci-dessous. Nous vous recommandons d’utiliser HTTPS.

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

Demande de service de stockage émulée

Lorsque vous effectuez une requête 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, suivi du nom du compte de stockage émulé :

Méthode URI de demande Version HTTP
GET/HEAD http://127.0.0.1:10001/devstoreaccount1/myqueue?comp=metadata HTTP/1.1

Pour plus d’informations, consultez Utiliser l’émulateur Azurite à des fins de développement local pour Stockage Azure.

Paramètres URI

Les paramètres supplémentaires suivants peuvent être spécifiés sur l’URI de demande :

Paramètre Description
timeout facultatif. Le paramètre timeout est exprimé en secondes. Pour plus d’informations, consultez Définir des délais d’expiration pour les opérations de stockage file d’attente Azure.

En-têtes de requête

Les en-têtes de requête obligatoires et facultatifs sont décrits dans le tableau suivant :

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 reçues par le serveur. Pour plus d’informations, consultez Surveiller le stockage File d’attente Azure.

Corps de la demande

Aucun.

response

La réponse inclut un code d'état HTTP et un ensemble d'en-têtes de réponse.

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 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-approximate-messages-count:int-value Nombre approximatif de messages dans la file d'attente. Ce nombre n’est pas inférieur au nombre réel de messages dans la file d’attente, mais peut être supérieur.
x-ms-meta-name:string-value Une paire nom-valeur définie par l'utilisateur.
x-ms-request-id Identifie de manière unique la demande qui a été effectuée et peut être utilisée pour résoudre la demande. Pour plus d’informations, consultez Résoudre les problèmes liés aux opérations d’API.
x-ms-version Indique la version du stockage File d’attente Azure utilisée pour exécuter la demande. Cet en-tête est retourné pour les demandes effectuées sur la version 2009-09-19 ou ultérieure.
Date Valeur de date/heure UTC générée par le service, qui indique l’heure à laquelle la réponse a été lancée.
x-ms-client-request-id Peut être utilisé pour résoudre les demandes et leurs 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 et que la valeur ne contient pas plus 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, il ne sera pas présent dans la réponse.

Response body

Aucun.

Exemple de réponse

Response Status:  
HTTP/1.1 200 OK  
  
Response Headers:  
Transfer-Encoding: chunked  
x-ms-approximate-messages-count: 0  
Date: Fri, 16 Sep 2011 01:27:38 GMT  
Server: Windows-Azure-Queue/1.0 Microsoft-HTTPAPI/2.0

Autorisation

Cette opération peut être effectuée par le propriétaire du compte et par toute personne disposant d’une signature d’accès partagé avec des autorisations pour effectuer cette opération.

Notes

Aucun.

Voir aussi

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