VERTRIEB: 1-800-867-1380

List Queues

Letzte Aktualisierung: April 2015

Dieser Vorgang listet alle Warteschlangen in einem angegebenen Speicherkonto auf.

Die List Queues-Anforderung kann wie folgt erstellt werden. 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

Wenn Sie eine Anforderung für den emulierten Speicherdienst ausführen, geben Sie den Emulatorhostnamen und den Port des Warteschlangendiensts mit 127.0.0.1:10001 an, gefolgt vom Namen des emulierten Speicherkontos:

 

Methode Anforderungs-URI HTTP-Version

GET

http://127.0.0.1:10001/devstoreaccount1?comp=list

HTTP/1.1

Im Anforderungs-URI können die folgenden zusätzlichen Parameter angegeben werden.

 

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 im Antworttext ein NextMarker-Element zurück, wenn keine vollständige Liste zurückgegeben wurde. Dieser Wert kann anschließend als Abfrageparameter in einem nachfolgenden Aufruf angegeben werden, um den nächsten Teil der Warteschlangenliste 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 die mit diesem Parameter angeforderten Metadaten gemäß den Benennungsbeschränkungen gespeichert werden müssen, die für Version 2009-09-19 des Warteschlangendiensts gelten. 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 Vorgänge des Warteschlangendiensts.

In der folgenden Tabelle werden erforderliche und optionale Anforderungsheader beschrieben.

 

Anforderungsheader Beschreibung

Authorization

Erforderlich. Gibt das Authentifizierungsschema, den Kontonamen und die Signatur an. Weitere Informationen finden Sie unter Authentifizierung für die Azure-Speicherdienste.

Date - oder - x-ms-date

Erforderlich. Gibt die Uhrzeit der Anforderung in koordinierter Weltzeit (UTC) an. Weitere Informationen finden Sie unter Authentifizierung für die Azure-Speicherdienste.

x-ms-version

Optional. Gibt die Version des für die Anforderung zu verwendenden Vorgangs an. Weitere Informationen finden Sie unter Versionsverwaltung für den Blob-Dienst, den Warteschlangendienst und den Tabellendienst in Windows Azure.

x-ms-client-request-id

Optional. Stellt einen vom Client generierten, nicht transparenten Wert mit einer Zeichenbeschränkung von 1 KB bereit, der bei Aktivierung der Speicheranalyse-Protokollierung in den Analyseprotokollen erfasst wird. Die Verwendung dieses Headers wird dringend empfohlen, um clientseitige Aktivitäten mit den vom Server empfangenen Anforderungen zu korrelieren. Weitere Informationen finden Sie unter Informationen zur Protokollierung durch die Speicheranalyse und Azure-Speicherprotokollierung: Verwenden von Protokollen zur Nachverfolgung von Speicheranforderungen.

Eine Beispielanforderung finden Sie unten im Abschnitt mit Beispielanforderung und -antwort.

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

Bei einem erfolgreichen Vorgang wird der Statuscode 200 (OK) zurückgegeben.

Weitere Informationen zu Statuscodes finden Sie unter Status- und Fehlercodes.

Die Antwort für diesen Vorgang umfasst die folgenden Header. Die Antwort kann außerdem weitere HTTP-Standardheader enthalten. Alle Standardheader entsprechen der HTTP/1.1-Protokollspezifikation.

 

Antwortheader Beschreibung

x-ms-request-id

Dieser Header identifiziert die erfolgte Anforderung eindeutig 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 des Warteschlangendiensts an, der zum Ausführen der Abfrage verwendet wird. Dieser Header wird für Anforderungen zurückgegeben, die für Version 2009-09-19 und höher erfolgen.

Date

Ein vom Dienst generierter Datums-/Uhrzeitwert in UTC, der angibt, wann die Antwort initiiert wurde.

Der Antworttext weist das folgende Format auf. Beachten Sie, dass die Elemente Prefix, Marker und MaxResults nur vorhanden sind, wenn sie im URI angegeben wurden. Das NextMarker-Element weist nur einen Wert auf, wenn die Listenergebnisse nicht vollständig sind.

Bei Version 2013-08-15 und höheren Versionen wurde das AccountName-Attribut für das EnumerationResults-Element in ServiceEndpoint umbenannt. 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>
      …

Eine Beispielantwort finden Sie unten im Abschnitt mit Beispielanforderung und -antwort.

Dieser Vorgang kann nur vom Kontobesitzer aufgerufen werden.

Wenn Sie einen Wert für den maxresults-Parameter angeben und die Anzahl der zurückzugebenden Warteschlangen diesen Wert oder den Standardwert für maxresults überschreitet, enthält der Antworttext ein NextMarker-Element, das die folgende Warteschlange angibt, 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.

Es folgt ein Beispiel-URI, der die Liste der Warteschlangen für ein Konto anfordert, wobei die maximale Anzahl der für den anfänglichen Vorgang zurückzugebenden Ergebnisse auf 3 festgelegt ist.

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 auf den 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 ab der vom Marker angegebenen Warteschlange zurückgegeben. 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>

Fanden Sie dies hilfreich?
(1500 verbleibende Zeichen)
Vielen Dank für Ihr Feedback.
Anzeigen:
© 2015 Microsoft