Wachtrijen weergeven

Artikel
06/27/2023

Met deze bewerking worden alle wachtrijen in een bepaald opslagaccount weergegeven.

Aanvraag

U kunt de List Queues aanvraag als volgt samenstellen. HTTPS wordt aanbevolen. Vervang myaccount door de naam van uw opslagaccount.

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

Geëmuleerde opslagservice-URI

Wanneer u een aanvraag doet voor de geëmuleerde opslagservice, geeft u de hostnaam van de emulator en de Azure Queue Storage-poort op als 127.0.0.1:10001, gevolgd door de naam van het geëmuleerde opslagaccount.

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

URI-parameters

U kunt de volgende aanvullende parameters opgeven voor de aanvraag-URI.

Parameter	Beschrijving
`prefix`	Filtert de resultaten om alleen wachtrijen met namen te retourneren die beginnen met het opgegeven voorvoegsel.
`marker`	Een tekenreekswaarde die het gedeelte van de lijst aangeeft dat moet worden geretourneerd bij de volgende lijstbewerking. De bewerking retourneert een `NextMarker` element in de antwoordtekst, als de geretourneerde lijst niet is voltooid. U kunt deze waarde vervolgens gebruiken als een queryparameter in een volgende aanroep om het volgende gedeelte van de lijst met wachtrijen aan te vragen. De markeringswaarde is ondoorzichtig voor de client.
`maxresults`	Hiermee geeft u het maximum aantal wachtrijen op dat moet worden geretourneerd. Als `maxresults` niet is opgegeven, retourneert de server maximaal 5000 items.
`include=metadata`	Optioneel. Neem deze parameter op om op te geven dat de metagegevens van de container worden geretourneerd als onderdeel van de antwoordtekst. Houd er rekening mee dat metagegevens die met deze parameter worden aangevraagd, moeten worden opgeslagen in overeenstemming met de naamgevingsbeperkingen die zijn opgelegd door de 2009-09-19-versie van Queue Storage. Vanaf deze versie moeten alle metagegevensnamen voldoen aan de naamconventies voor C#-id's.
`timeout`	Optioneel. De `timeout` parameter wordt uitgedrukt in seconden. Zie Time-outs instellen voor Queue Storage-bewerkingen voor meer informatie.

Aanvraagheaders

In de volgende tabel worden vereiste en optionele aanvraagheaders beschreven.

Aanvraagheader	Beschrijving
`Authorization`	Vereist. Hiermee geeft u het autorisatieschema, de accountnaam en de handtekening. Zie Aanvragen voor Azure Storage autoriseren voor meer informatie.
`Date` of `x-ms-date`	Vereist. Geef de Coordinated Universal Time (UTC) op voor de aanvraag. Zie Aanvragen voor Azure Storage autoriseren voor meer informatie.
`x-ms-version`	Optioneel. Hiermee geeft u de versie van de bewerking te gebruiken voor deze aanvraag. Zie Versiebeheer voor de Azure Storage-services voor meer informatie.
`x-ms-client-request-id`	Optioneel. Biedt een door de client gegenereerde, ondoorzichtige waarde met een limiet van 1 kibibyte (KiB) die wordt vastgelegd in de logboeken wanneer logboekregistratie is geconfigureerd. We raden u ten zeerste aan deze header te gebruiken om activiteiten aan de clientzijde te correleren met aanvragen die de server ontvangt. Zie Azure Queue Storage bewaken voor meer informatie.

Aanvraagbody

Geen.

Voorbeeldaanvraag

Raadpleeg de sectie Voorbeeldaanvraag en antwoord verderop in dit artikel.

Antwoord

Het antwoord bevat een HTTP-statuscode, een set antwoordheaders en een antwoordtekst met de lijst met wachtrijen.

Statuscode

Een geslaagde bewerking retourneert statuscode 200 (OK). Zie Status- en foutcodes voor meer informatie over statuscodes.

Antwoordheaders

Het antwoord voor deze bewerking bevat de volgende headers. Het antwoord kan ook extra, standaard HTTP-headers bevatten. Alle standaardheaders voldoen aan de HTTP/1.1-protocolspecificatie.

Antwoordheader	Beschrijving
`x-ms-request-id`	Deze header identificeert op unieke wijze de aanvraag die is gedaan en kan worden gebruikt voor het oplossen van problemen met de aanvraag. Zie Problemen met API-bewerkingen oplossen voor meer informatie.
`x-ms-version`	Geeft de versie van Queue Storage aan die wordt gebruikt om de aanvraag uit te voeren. Deze header wordt geretourneerd voor aanvragen die zijn gedaan op basis van versie 2009-09-19 en hoger.
`Date`	Een UTC-datum/tijd-waarde die de tijd aangeeft waarop het antwoord is gestart. De service genereert deze waarde.
`x-ms-client-request-id`	U kunt deze header gebruiken om problemen met aanvragen en bijbehorende antwoorden op te lossen. De waarde van deze header is gelijk aan de waarde van de `x-ms-client-request-id` header, als deze aanwezig is in de aanvraag. De waarde is maximaal 1024 zichtbare ASCII-tekens. Als de `x-ms-client-request-id` header niet aanwezig is in de aanvraag, is deze header niet aanwezig in het antwoord.

Hoofdtekst van de reactie

De indeling van de hoofdtekst van het antwoord is als volgt. Houd er rekening mee dat de Prefixelementen , Markeren MaxResults alleen aanwezig zijn als u deze op de URI hebt opgegeven. Het NextMarker element heeft alleen een waarde als de lijstresultaten niet volledig zijn.

Voor versie 2013-08-15 en hoger is de naam van het AccountName kenmerk voor het EnumerationResults -element gewijzigd in ServiceEndpoint. Bovendien is het Url element onder Queue verwijderd.

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

Het Metadata element is alleen aanwezig als de include=metadata parameter is opgegeven in de URI. Binnen het Metadata element wordt de waarde van elk naam-waardepaar weergegeven in een element dat overeenkomt met de naam van het paar.

Als een metagegevensnaam-waardepaar in strijd is met de naamgevingsbeperkingen die worden afgedwongen door de versie 2009-09-19, geeft de antwoordtekst de problematische naam in een x-ms-invalid-name element aan, zoals wordt weergegeven in het volgende XML-fragment:

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

Voorbeeldantwoord

Raadpleeg de sectie Voorbeeldaanvraag en antwoord verderop in dit artikel.

Autorisatie

Alleen de accounteigenaar kan deze bewerking aanroepen.

Opmerkingen

Als u een waarde opgeeft voor de maxresults parameter en het aantal wachtrijen dat moet worden geretourneerd deze waarde overschrijdt of de standaardwaarde voor maxresultsoverschrijdt, bevat de antwoordtekst een NextMarker -element. Dit element geeft de volgende wachtrij aan die moet worden geretourneerd bij een volgende aanvraag. Als u de volgende set items wilt retourneren, geeft u de waarde van NextMarker op als de markeringsparameter op de URI voor de volgende aanvraag.

Houd er rekening mee dat de waarde van NextMarker moet worden behandeld als ondoorzichtig.

Wachtrijen worden in alfabetische volgorde weergegeven in de hoofdtekst van het antwoord.

Voorbeeld van aanvraag en antwoord

Hier volgt een voorbeeld-URI waarmee de lijst met wachtrijen voor een account wordt aangevraagd. Hiermee worden de maximaal te retourneren resultaten voor de eerste bewerking ingesteld op drie.

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

De aanvraag wordt verzonden met deze headers:

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

De statuscode en antwoordheaders worden als volgt geretourneerd:

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

De antwoord-XML voor deze aanvraag is als volgt. Houd er rekening mee dat het NextMarker element de set wachtrijen volgt en de naam bevat van de volgende wachtrij die moet worden geretourneerd.

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

De volgende lijstbewerking geeft de markering op de aanvraag-URI op, als volgt. De volgende set resultaten wordt geretourneerd, te beginnen met de wachtrij die is opgegeven door de markering. Dit is de URI voor de volgende aanvraag:

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

De antwoordtekst voor deze bewerking is als volgt:

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

Zie ook

Aanvragen autoriseren voor Azure Storage
Status en foutcodes
Queue Storage-foutcodes

Delen via