Wyświetlanie listy kolejek

Artykuł
08/05/2023

Ta operacja zawiera listę wszystkich kolejek na określonym koncie magazynu.

Żądanie

Żądanie można skonstruować List Queues w następujący sposób. Zalecane jest użycie protokołu HTTPS. Zastąp ciąg myaccount nazwą konta magazynu.

Metoda	Identyfikator URI żądania	Wersja PROTOKOŁU HTTP
`GET`	`https://myaccount.queue.core.windows.net?comp=list`	HTTP/1.1

Identyfikator URI usługi magazynu emulowanego

Po wysłaniu żądania względem emulowanej usługi magazynu określ nazwę hosta emulatora i port usługi Azure Queue Storage jako 127.0.0.1:10001, a następnie nazwę emulowanego konta magazynu.

Metoda	Identyfikator URI żądania	Wersja PROTOKOŁU HTTP
`GET`	`http://127.0.0.1:10001/devstoreaccount1?comp=list`	HTTP/1.1

Parametry identyfikatora URI

W identyfikatorze URI żądania można określić następujące dodatkowe parametry.

Parametr	Opis
`prefix`	Filtruje wyniki, aby zwracać tylko kolejki z nazwami rozpoczynającymi się od określonego prefiksu.
`marker`	Wartość ciągu identyfikującą część listy, która ma zostać zwrócona przy użyciu następnej operacji listy. Operacja zwraca `NextMarker` element w treści odpowiedzi, jeśli zwrócona lista nie została ukończona. Następnie możesz użyć tej wartości jako parametru zapytania w kolejnym wywołaniu, aby zażądać kolejnej części listy kolejek. Wartość znacznika jest nieprzezroczysta dla klienta.
`maxresults`	Określa maksymalną liczbę kolejek do zwrócenia. Jeśli `maxresults` nie zostanie określony, serwer zwróci maksymalnie 5000 elementów.
`include=metadata`	Opcjonalny. Uwzględnij ten parametr, aby określić, że metadane kontenera są zwracane w ramach treści odpowiedzi. Należy pamiętać, że metadane żądane za pomocą tego parametru muszą być przechowywane zgodnie z ograniczeniami nazewnictwa nałożonymi przez wersję usługi Queue Storage w wersji 2009-09-19. Począwszy od tej wersji, wszystkie nazwy metadanych muszą być zgodne z konwencjami nazewnictwa identyfikatorów języka C#.
`timeout`	Opcjonalny. Parametr jest wyrażony `timeout` w sekundach. Aby uzyskać więcej informacji, zobacz Ustawianie limitów czasu dla operacji usługi Queue Storage.

Nagłówki żądań

W poniższej tabeli opisano wymagane i opcjonalne nagłówki żądań.

Nagłówek żądania	Opis
`Authorization`	Wymagane. Określa schemat autoryzacji, nazwę konta i podpis. Aby uzyskać więcej informacji, zobacz Autoryzowanie żądań do usługi Azure Storage.
`Date` lub `x-ms-date`	Wymagane. Określa dla żądania godzinę w formacie uniwersalnego czasu koordynowanego (UTC). Aby uzyskać więcej informacji, zobacz Autoryzowanie żądań do usługi Azure Storage.
`x-ms-version`	Opcjonalny. Określa wersję operacji do użycia dla tego żądania. Aby uzyskać więcej informacji, zobacz Przechowywanie wersji usług Azure Storage.
`x-ms-client-request-id`	Opcjonalny. Udostępnia nieprzezroczystą wartość wygenerowaną przez klienta z limitem znaków 1-kibibyte (KiB), który jest rejestrowany w dziennikach podczas konfigurowania rejestrowania. Zdecydowanie zalecamy używanie tego nagłówka do korelowania działań po stronie klienta z żądaniami odbieranymi przez serwer. Aby uzyskać więcej informacji, zobacz Monitorowanie usługi Azure Queue Storage.

Treść żądania

Brak.

Przykładowe żądanie

Zapoznaj się z sekcją "Przykładowe żądanie i odpowiedź" w dalszej części tego artykułu.

Reakcja

Odpowiedź zawiera kod stanu HTTP, zestaw nagłówków odpowiedzi oraz treść odpowiedzi zawierającą listę kolejek.

Kod stanu

Operacja zakończona powodzeniem zwraca kod stanu 200 (OK). Aby uzyskać informacje o kodach stanu, zobacz Stan i kody błędów.

Nagłówki odpowiedzi

Odpowiedź na tę operację zawiera następujące nagłówki. Odpowiedź może również zawierać dodatkowe, standardowe nagłówki HTTP. Wszystkie nagłówki standardowe są zgodne ze specyfikacją protokołu HTTP/1.1.

Nagłówek odpowiedzi	Opis
`x-ms-request-id`	Ten nagłówek jednoznacznie identyfikuje wykonane żądanie i może służyć do rozwiązywania problemów z żądaniem. Aby uzyskać więcej informacji, zobacz Rozwiązywanie problemów z operacjami interfejsu API.
`x-ms-version`	Wskazuje wersję usługi Queue Storage używaną do uruchomienia żądania. Ten nagłówek jest zwracany dla żądań wysyłanych w wersji 2009-09-19 lub nowszej.
`Date`	Wartość daty/godziny UTC wskazująca godzinę, w której zainicjowano odpowiedź. Usługa generuje tę wartość.
`x-ms-client-request-id`	Ten nagłówek służy do rozwiązywania problemów z żądaniami i odpowiadającymi im odpowiedziami. Wartość tego nagłówka jest równa wartości `x-ms-client-request-id` nagłówka, jeśli jest obecna w żądaniu. Wartość wynosi co najwyżej 1024 widoczne znaki ASCII. `x-ms-client-request-id` Jeśli nagłówek nie znajduje się w żądaniu, ten nagłówek nie będzie obecny w odpowiedzi.

Treść odpowiedzi

Format treści odpowiedzi jest następujący. Należy pamiętać, że Prefixelementy , Markeri MaxResults są obecne tylko wtedy, gdy określono je w identyfikatorze URI. Element NextMarker ma wartość tylko wtedy, gdy wyniki listy nie zostaną ukończone.

W przypadku wersji 2013-08-15 i nowszej AccountNameEnumerationResults atrybut elementu został zmieniony na ServiceEndpoint. Ponadto Url element w obszarze Queue został usunięty.

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

Element Metadata jest obecny tylko wtedy, gdy include=metadata parametr został określony w identyfikatorze URI. Metadata W elemecie wartość każdej pary name-value jest wyświetlana w elemecie odpowiadającym nazwie pary.

Jeśli para nazwa-wartość metadanych narusza ograniczenia nazewnictwa wymuszone przez wersję 2009-09-19, treść odpowiedzi wskazuje problematyczną nazwę elementu x-ms-invalid-name , jak pokazano w następującym fragmentcie XML:

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

Przykładowa odpowiedź

Zapoznaj się z sekcją "Przykładowe żądanie i odpowiedź" w dalszej części tego artykułu.

Autoryzacja

Tylko właściciel konta może wywołać tę operację.

Uwagi

Jeśli określisz wartość parametrumaxresults, a liczba kolejek do zwrócenia przekracza tę wartość lub przekroczy wartość domyślną NextMarker dla maxresultsparametru , treść odpowiedzi zawiera element. Ten element wskazuje następną kolejkę do zwrócenia na kolejne żądanie. Aby zwrócić następny zestaw elementów, określ wartość NextMarker parametru znacznika w identyfikatorze URI dla kolejnego żądania.

Należy pamiętać, że wartość NextMarker powinna być traktowana jako nieprzezroczyste.

Kolejki są wyświetlane w kolejności alfabetycznej w treści odpowiedzi.

Przykładowe żądanie i odpowiedź

Oto przykładowy identyfikator URI, który żąda listy kolejek dla konta. Ustawia maksymalną liczbę wyników, które mają być zwracane dla operacji początkowej na trzy.

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

Żądanie jest wysyłane z następującymi nagłówkami:

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

Kod stanu i nagłówki odpowiedzi są zwracane w następujący sposób:

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

Kod XML odpowiedzi dla tego żądania jest następujący. Należy pamiętać, że NextMarker element jest zgodny z zestawem kolejek i zawiera nazwę następnej kolejki do zwrócenia.

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

Kolejna operacja listy określa znacznik identyfikatora URI żądania w następujący sposób. Zostanie zwrócony następny zestaw wyników, zaczynając od kolejki określonej przez znacznik. Oto identyfikator URI kolejnego żądania:

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

Treść odpowiedzi dla tej operacji jest następująca:

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

Zobacz też

Autoryzowanie żądań do usługi Azure Storage
Kody stanu i błędów
Kody błędów usługi Queue Storage