Lista köer

Artikel
06/27/2023

Den här åtgärden visar alla köer i ett visst lagringskonto.

Förfrågan

Du kan skapa begäran på List Queues följande sätt. HTTPS rekommenderas. Ersätt myaccount med namnet på ditt lagringskonto.

Metod	URI för förfrågan	HTTP-version
`GET`	`https://myaccount.queue.core.windows.net?comp=list`	HTTP/1.1

Emulerad lagringstjänst-URI

När du gör en begäran mot den emulerade lagringstjänsten anger du emulatorns värdnamn och Azure Queue Storage-porten som 127.0.0.1:10001, följt av namnet på det emulerade lagringskontot.

Metod	URI för förfrågan	HTTP-version
`GET`	`http://127.0.0.1:10001/devstoreaccount1?comp=list`	HTTP/1.1

URI-parametrar

Du kan ange följande ytterligare parametrar för begärande-URI:n.

Parameter	Beskrivning
`prefix`	Filtrerar resultatet så att endast köer returneras med namn som börjar med det angivna prefixet.
`marker`	Ett strängvärde som identifierar den del av listan som ska returneras med nästa liståtgärd. Åtgärden returnerar ett `NextMarker` element i svarstexten om listan som returnerades inte slutfördes. Du kan sedan använda det här värdet som en frågeparameter i ett efterföljande anrop för att begära nästa del av listan över köer. Markörvärdet är ogenomskinlig för klienten.
`maxresults`	Anger det maximala antalet köer som ska returneras. Om `maxresults` inte anges returnerar servern upp till 5 000 objekt.
`include=metadata`	Valfritt. Inkludera den här parametern för att ange att containerns metadata ska returneras som en del av svarstexten. Observera att metadata som begärs med den här parametern måste lagras i enlighet med namngivningsbegränsningarna i 2009-09-19-versionen av Queue Storage. Från och med den här versionen måste alla metadatanamn följa namngivningskonventionerna för C#-identifierare.
`timeout`	Valfritt. Parametern `timeout` uttrycks i sekunder. Mer information finns i Ange tidsgränser för kölagringsåtgärder.

Begärandehuvuden

I följande tabell beskrivs obligatoriska och valfria begärandehuvuden.

Begärandehuvud	Beskrivning
`Authorization`	Krävs. Anger auktoriseringsschema, kontonamn och signatur. Mer information finns i Auktorisera begäranden till Azure Storage.
`Date` eller `x-ms-date`	Krävs. Anger Coordinated Universal Time (UTC) för begäran. Mer information finns i Auktorisera begäranden till Azure Storage.
`x-ms-version`	Valfritt. Anger vilken version av åtgärden som ska användas för den här begäran. Mer information finns i Versionshantering för Azure Storage-tjänsterna.
`x-ms-client-request-id`	Valfritt. Tillhandahåller ett klientgenererat, täckande värde med en teckengräns på 1 kibibyte (KiB) som registreras i loggarna när loggningen har konfigurerats. Vi rekommenderar starkt att du använder det här huvudet för att korrelera aktiviteter på klientsidan med begäranden som servern tar emot. Mer information finns i Övervaka Azure Queue Storage.

Begärandetext

Inga.

Exempelbegäran

Se avsnittet "Exempelbegäran och svar" senare i den här artikeln.

Svarsåtgärder

Svaret innehåller en HTTP-statuskod, en uppsättning svarshuvuden och en svarstext som innehåller listan över köer.

Statuskod

En lyckad åtgärd returnerar statuskoden 200 (OK). Information om statuskoder finns i Status och felkoder.

Svarshuvuden

Svaret för den här åtgärden innehåller följande rubriker. Svaret kan också innehålla ytterligare standard-HTTP-huvuden. Alla standardhuvuden överensstämmer med HTTP/1.1-protokollspecifikationen.

Svarsrubrik	Description
`x-ms-request-id`	Det här huvudet identifierar unikt den begäran som gjordes och kan användas för att felsöka begäran. Mer information finns i Felsöka API-åtgärder.
`x-ms-version`	Anger vilken version av Queue Storage som används för att köra begäran. Det här huvudet returneras för begäranden mot version 2009-09-19 och senare.
`Date`	Ett UTC-datum/tid-värde som anger den tid då svaret initierades. Tjänsten genererar det här värdet.
`x-ms-client-request-id`	Du kan använda det här huvudet för att felsöka begäranden och motsvarande svar. Värdet för det här huvudet är lika med värdet för `x-ms-client-request-id` huvudet, om det finns i begäran. Värdet är högst 1 024 synliga ASCII-tecken. `x-ms-client-request-id` Om rubriken inte finns i begäran visas inte det här huvudet i svaret.

Själva svaret

Formatet för svarstexten är följande. Observera att elementen Prefix, Markeroch MaxResults bara finns om du har angett dem på URI:n. Elementet NextMarker har bara ett värde om listresultatet inte är klart.

För version 2013-08-15 och senare AccountName har attributet för elementet EnumerationResults bytt namn till ServiceEndpoint. Dessutom har elementet Url under Queue tagits bort.

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

Elementet Metadata finns bara om parametern include=metadata har angetts för URI:n. I elementet Metadata visas värdet för varje namn/värde-par i ett element som motsvarar parets namn.

Om ett namn/värde-metadatapar bryter mot namngivningsbegränsningarna som tillämpas av versionen 2009-09-19 anger svarstexten det problematiska namnet i ett x-ms-invalid-name element, enligt följande XML-fragment:

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

Exempelsvar

Se avsnittet "Exempelbegäran och svar" senare i den här artikeln.

Auktorisering

Endast kontoägaren kan anropa den här åtgärden.

Kommentarer

Om du anger ett värde för parametern maxresults och antalet köer som ska returneras överskrider det här värdet, eller överskrider standardvärdet för maxresults, innehåller svarstexten ett NextMarker element. Det här elementet anger nästa kö som ska returneras för en efterföljande begäran. Om du vill returnera nästa uppsättning objekt anger du värdet NextMarker för som markörparameter för URI:n för den efterföljande begäran.

Observera att värdet NextMarker för ska behandlas som ogenomskinlig.

Köer visas i alfabetisk ordning i svarstexten.

Exempel på begäran och svar

Här är en exempel-URI som begär listan över köer för ett konto. Den anger det maximala resultatet som ska returneras för den inledande åtgärden till tre.

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

Begäran skickas med följande rubriker:

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

Statuskoden och svarshuvudena returneras på följande sätt:

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

Svars-XML för den här begäran är följande. Observera att elementet NextMarker följer uppsättningen köer och innehåller namnet på nästa kö som ska returneras.

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

Den efterföljande liståtgärden anger markören på begärande-URI:n enligt följande. Nästa uppsättning resultat returneras, med början i kön som anges av markören. Här är URI:n för efterföljande begäran:

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

Svarstexten för den här åtgärden är följande:

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

Se även

Auktorisera begäranden till Azure Storage
Status- och felkoder
Kölagringsfelkoder

Dela via