Auflisten von Warteschlangen

Artikel
06/27/2023

Dieser Vorgang listet alle Warteschlangen in einem bestimmten Speicherkonto auf.

Anforderung

Sie können die List Queues Anforderung wie folgt erstellen. HTTPS wird empfohlen. Ersetzen Sie myaccount durch den Namen Ihres Speicherkontos.

Methode	Anforderungs-URI	HTTP-Version
`GET`	`https://myaccount.queue.core.windows.net?comp=list`	HTTP/1.1

Emulierter Speicherdienst-URI

Wenn Sie eine Anforderung für den emulierten Speicherdienst stellen, geben Sie den Hostnamen des Emulators und den Azure Queue Storage-Port als 127.0.0.1:10001an, gefolgt vom Namen des emulierten Speicherkontos.

Methode	Anforderungs-URI	HTTP-Version
`GET`	`http://127.0.0.1:10001/devstoreaccount1?comp=list`	HTTP/1.1

URI-Parameter

Sie können die folgenden zusätzlichen Parameter für den Anforderungs-URI angeben.

Parameter	BESCHREIBUNG
`prefix`	Filtert die Ergebnisse, sodass nur Warteschlangen mit einem Namen zurückgegeben werden, der mit dem angegebenen Präfix beginnt.
`marker`	Ein Zeichenfolgenwert, der den Teil der Liste angibt, der mit dem nächsten Auflistungsvorgang zurückgegeben wird. Der Vorgang gibt ein `NextMarker` Element innerhalb des Antworttexts zurück, wenn die zurückgegebene Liste nicht vollständig war. Sie können diesen Wert dann als Abfrageparameter in einem nachfolgenden Aufruf verwenden, um den nächsten Teil der Liste der Warteschlangen anzufordern. Der Markerwert ist für den Client nicht transparent.
`maxresults`	Gibt die maximale zurückzugebende Anzahl von Warteschlangen an. Wenn `maxresults` nicht angegeben ist, gibt der Server bis zu 5.000 Elemente zurück.
`include=metadata`	Optional. Schließen Sie diesen Parameter ein, um anzugeben, dass die Metadaten des Containers als Teil des Antworttexts zurückgegeben werden sollen. Beachten Sie, dass mit diesem Parameter angeforderte Metadaten gemäß den Benennungseinschränkungen gespeichert werden müssen, die von der Version 2009-09-19 von Queue Storage auferlegt wurden. Ab dieser Version müssen alle Metadatennamen den Benennungskonventionen für C#-Bezeichner entsprechen.
`timeout`	Optional. Der `timeout`-Parameter wird in Sekunden angegeben. Weitere Informationen finden Sie unter Festlegen von Timeouts für Warteschlangenspeichervorgänge.

Anforderungsheader

In der folgenden Tabelle werden erforderliche und optionale Anforderungsheader beschrieben.

Anforderungsheader	BESCHREIBUNG
`Authorization`	Erforderlich. Gibt das Autorisierungsschema, den Kontonamen und die Signatur an. Weitere Informationen finden Sie unter Autorisieren von Anforderungen an Azure Storage.
`Date` oder `x-ms-date`	Erforderlich. Gibt die koordinierte Weltzeit (Coordinated Universal Time, UTC) für die Anforderung an. Weitere Informationen finden Sie unter Autorisieren von Anforderungen an Azure Storage.
`x-ms-version`	Optional. Gibt die Version des für die Anforderung zu verwendenden Vorgangs an. Weitere Informationen finden Sie unter Versionsverwaltung für die Azure-Speicherdienste.
`x-ms-client-request-id`	Optional. Stellt einen vom Client generierten, undurchsichtigen Wert mit einem Zeichenlimit von 1 Kibibyte (KiB) bereit, der beim Konfigurieren der Protokollierung in den Protokollen aufgezeichnet wird. Es wird dringend empfohlen, diesen Header zu verwenden, um clientseitige Aktivitäten mit Anforderungen zu korrelieren, die der Server empfängt. Weitere Informationen finden Sie unter Überwachen von Azure Queue Storage.

Anforderungstext

Keine.

Beispiel für eine Anforderung

Weitere Informationen finden Sie weiter unten in diesem Artikel im Abschnitt "Beispielanforderung und -antwort".

Antwort

Die Antwort enthält den HTTP-Statuscode, einen Satz von Antwortheadern sowie einen Antworttext mit der Liste der Warteschlangen.

Statuscode

Bei einem erfolgreichen Vorgang wird der Statuscode 200 (OK) zurückgegeben. Informationen zu status Codes finden Sie unter Status- und Fehlercodes.

Antwortheader

Die Antwort für diesen Vorgang umfasst die folgenden Header. Die Antwort kann auch zusätzliche HTTP-Standardheader enthalten. Alle Standardheader entsprechen der HTTP/1.1-Protokollspezifikation.

Antwortheader	BESCHREIBUNG
`x-ms-request-id`	Dieser Header identifiziert eindeutig die Anforderung, die gestellt wurde, und kann für die Problembehandlung der Anforderung verwendet werden. Weitere Informationen finden Sie unter Problembehandlung für API-Vorgänge.
`x-ms-version`	Gibt die Version von Warteschlangenspeicher an, die zum Ausführen der Anforderung verwendet wird. Dieser Header wird für Anforderungen zurückgegeben, die für Version 2009-09-19 und höher erfolgen.
`Date`	Ein UTC-Datums-/Uhrzeitwert, der die Uhrzeit angibt, zu der die Antwort initiiert wurde. Der Dienst generiert diesen Wert.
`x-ms-client-request-id`	Sie können diesen Header verwenden, um Probleme mit Anforderungen und entsprechenden Antworten zu beheben. Der Wert dieses Headers entspricht dem Wert des `x-ms-client-request-id` Headers, wenn er in der Anforderung vorhanden ist. Der Wert ist höchstens 1024 sichtbare ASCII-Zeichen. Wenn der `x-ms-client-request-id` Header in der Anforderung nicht vorhanden ist, ist dieser Header in der Antwort nicht vorhanden.

Antworttext

Das Format des Antworttexts sieht wie folgt aus. Beachten Sie, dass die PrefixElemente , Markerund MaxResults nur vorhanden sind, wenn Sie sie für den URI angegeben haben. Das NextMarker Element verfügt nur dann über einen Wert, wenn die Listenergebnisse nicht vollständig sind.

Ab Version 2013-08-15 wurde das AccountName Attribut für das EnumerationResults -Element in ServiceEndpointumbenannt. Darüber hinaus wurde das Url-Element unter Queue entfernt.

<?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>

Das Metadata-Element ist nur vorhanden, wenn im URI der include=metadata-Parameter angegeben wurde. Im Metadata-Element wird der Wert jedes Name-Wert-Paars in einem Element aufgelistet, das dem Namen des Paars entspricht.

Wenn ein Name-Wert-Paar von Metadaten gegen die Benennungsbeschränkungen von Version 2009-09-19 verstößt, gibt der Antworttext den problematischen Namen in einem x-ms-invalid-name-Element an, wie im folgenden XML-Fragment gezeigt:

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

Beispiel für eine Antwort

Weitere Informationen finden Sie weiter unten in diesem Artikel im Abschnitt "Beispielanforderung und -antwort".

Authorization

Nur der Kontobesitzer kann diesen Vorgang aufrufen.

Hinweise

Wenn Sie einen Wert für den maxresults Parameter angeben und die Anzahl der zurückzugebenden Warteschlangen diesen Wert überschreitet oder den Standardwert für maxresultsüberschreitet, enthält der Antworttext ein NextMarker -Element. Dieses Element gibt die nächste Warteschlange an, die bei einer nachfolgenden Anforderung zurückgegeben werden soll. Geben Sie zum Zurückgeben des nächsten Satzes von Elementen den Wert von NextMarker als Markerparameter im URI für die nächste Anforderung an.

Beachten Sie, dass der Wert von NextMarker als nicht transparent behandelt werden muss.

Warteschlangen werden im Antworttext in alphabetischer Reihenfolge aufgeführt.

Beispielanforderung und -antwort

Hier sehen Sie einen Beispiel-URI, der die Liste der Warteschlangen für ein Konto anfordert. Die maximal für den ersten Vorgang zurückgegebenen Ergebnisse werden auf drei festgelegt.

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

Die Anforderung wird mit den folgenden Headern gesendet:

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

Der Statuscode und die Antwortheader werden wie folgt zurückgegeben:

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

Das Antwort-XML für diese Anforderung lautet wie folgt. Beachten Sie, dass das NextMarker Element dem Satz von Warteschlangen folgt und den Namen der nächsten zurückzugebenden Warteschlange enthält.

<?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>

Der folgende Auflistungsvorgang gibt den Marker im Anforderungs-URI wie folgt an. Der nächste Satz von Ergebnissen wird zurückgegeben, beginnend mit der durch die Markierung angegebenen Warteschlange. Im Folgenden wird der URI für die nachfolgende Anforderung angegeben:

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

Der Antworttext für diesen Vorgang lautet wie folgt:

<?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>

Weitere Informationen

Autorisieren von Anforderungen an Azure Storage
Status- und Fehlercodes
Queue Storage-Fehlercodes