Výpis front

Článek
08/05/2023

Tato operace vypíše všechny fronty v konkrétním účtu úložiště.

Žádost

Požadavek můžete sestavit List Queues následujícím způsobem. Doporučuje se https. Nahraďte myaccount názvem vašeho účtu úložiště.

Metoda	Identifikátor URI žádosti	Verze PROTOKOLU HTTP
`GET`	`https://myaccount.queue.core.windows.net?comp=list`	HTTP/1.1

Identifikátor URI služby emulovaného úložiště

Při vytváření požadavku na službu emulovaného úložiště zadejte název hostitele emulátoru a port služby Azure Queue Storage jako 127.0.0.1:10001, následovaný názvem emulovaného účtu úložiště.

Metoda	Identifikátor URI žádosti	Verze PROTOKOLU HTTP
`GET`	`http://127.0.0.1:10001/devstoreaccount1?comp=list`	HTTP/1.1

Parametry identifikátoru URI

V identifikátoru URI požadavku můžete zadat následující další parametry.

Parametr	Popis
`prefix`	Filtruje výsledky tak, aby vracely pouze fronty s názvy, které začínají zadanou předponou.
`marker`	Řetězcová hodnota, která identifikuje část seznamu, která má být vrácena při další operaci seznamu. Operace vrátí `NextMarker` prvek v těle odpovědi, pokud vrácený seznam nebyl dokončený. Tuto hodnotu pak můžete použít jako parametr dotazu v následném volání a vyžádat si další část seznamu front. Hodnota značky je pro klienta neprůžná.
`maxresults`	Určuje maximální počet front, které se mají vrátit. Pokud `maxresults` není zadaný, server vrátí až 5 000 položek.
`include=metadata`	Nepovinný parametr. Zahrnutím tohoto parametru určete, že metadata kontejneru se mají vracet jako součást těla odpovědi. Upozorňujeme, že metadata požadovaná pomocí tohoto parametru musí být uložena v souladu s omezeními pojmenování, která jsou stanovena ve verzi Queue Storage z 2009-09-19. Počínaje touto verzí musí všechny názvy metadat dodržovat zásady vytváření názvů pro identifikátory jazyka C#.
`timeout`	Nepovinný parametr. Parametr se `timeout` vyjadřuje v sekundách. Další informace najdete v tématu Nastavení časových limitů pro operace Queue Storage.

Hlavičky požadavku

Následující tabulka popisuje požadované a volitelné hlavičky požadavků.

Hlavička požadavku	Popis
`Authorization`	Povinná hodnota. Určuje schéma autorizace, název účtu a podpis. Další informace najdete v tématu Autorizace požadavků do služby Azure Storage.
`Date` nebo `x-ms-date`	Povinná hodnota. Určuje formát UTC (Coordinated Universal Time). Další informace najdete v tématu Autorizace požadavků do služby Azure Storage.
`x-ms-version`	Nepovinný parametr. Určuje verzi operace, která se má pro tento požadavek použít. Další informace najdete v tématu Správa verzí pro služby Azure Storage.
`x-ms-client-request-id`	Nepovinný parametr. Poskytuje klientem vygenerovanou neprůselnou hodnotu s limitem počtu znaků 1 kibibajt (KiB), který je zaznamenán v protokolech při konfiguraci protokolování. Důrazně doporučujeme použít tuto hlavičku ke korelaci aktivit na straně klienta s požadavky, které server přijímá. Další informace najdete v tématu Monitorování služby Azure Queue Storage.

Text požadavku

Žádné

Ukázkový požadavek

Projděte si část Ukázková žádost a odpověď dále v tomto článku.

Odpověď

Odpověď obsahuje stavový kód HTTP, sadu hlaviček odpovědi a text odpovědi obsahující seznam front.

Stavový kód

Úspěšná operace vrátí stavový kód 200 (OK). Informace o stavových kódech najdete v tématu Stavové kódy a kódy chyb.

Hlavičky odpovědi

Odpověď na tuto operaci obsahuje následující hlavičky. Odpověď může také obsahovat další standardní hlavičky HTTP. Všechny standardní hlavičky odpovídají specifikaci protokolu HTTP/1.1.

Hlavička odpovědi	Description
`x-ms-request-id`	Tato hlavička jednoznačně identifikuje požadavek, který byl proveden, a lze ji použít k řešení potíží s požadavkem. Další informace najdete v tématu Řešení potíží s operacemi rozhraní API.
`x-ms-version`	Označuje verzi služby Queue Storage použitou ke spuštění požadavku. Tato hlavička se vrátí pro požadavky provedené proti verzi 2009-09-19 a novější.
`Date`	Hodnota data a času UTC, která označuje čas, kdy byla odpověď zahájena. Tato služba vygeneruje tuto hodnotu.
`x-ms-client-request-id`	Tuto hlavičku můžete použít k řešení potíží s požadavky a odpovídajícími odpověďmi. Hodnota této hlavičky se rovná hodnotě `x-ms-client-request-id` hlavičky, pokud se nachází v požadavku. Hodnota je maximálně 1024 viditelných znaků ASCII. Pokud se hlavička `x-ms-client-request-id` v požadavku nenachází, nebude tato hlavička v odpovědi.

Text odpovědi

Text odpovědi má následující formát. Všimněte si, že elementy Prefix, Markera MaxResults jsou k dispozici pouze v případě, že jste je zadali v identifikátoru URI. Element NextMarker má hodnotu pouze v případě, že výsledky seznamu nejsou dokončené.

Pro verzi 2013-08-15 a novější AccountName byl atribut elementu EnumerationResults přejmenován na ServiceEndpoint. Kromě toho Url byl odebrán prvek pod Queue položkou .

<?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 je k dispozici pouze v případě, že include=metadata byl parametr zadán v identifikátoru URI. V elementu Metadata je hodnota každého páru název-hodnota uvedena v elementu odpovídajícím názvu páru.

Pokud dvojice název-hodnota metadat porušuje omezení pojmenování vynucená verzí 2009-09-19, text odpovědi označí problematický název v elementu x-ms-invalid-name , jak je znázorněno v následujícím fragmentu XML:

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

Ukázková odpověď

Projděte si část Ukázková žádost a odpověď dále v tomto článku.

Autorizace

Tuto operaci může volat pouze vlastník účtu.

Poznámky

Pokud zadáte hodnotu parametru maxresults a počet front, které se mají vrátit, překročí tuto hodnotu nebo překročí výchozí hodnotu pro maxresults, tělo odpovědi obsahuje NextMarker prvek. Tento prvek označuje další frontu, která se má vrátit při následném požadavku. Pokud chcete vrátit další sadu položek, zadejte hodnotu NextMarker jako parametr značky v identifikátoru URI pro následující požadavek.

Všimněte si, že hodnota NextMarker by měla být považována za neprůselnou.

Fronty jsou v textu odpovědi uvedené v abecedním pořadí.

Ukázkový požadavek a odpověď

Tady je ukázkový identifikátor URI, který vyžaduje seznam front pro účet. Nastaví maximální výsledky, které se mají vrátit pro počáteční operaci, na tři.

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

Požadavek se odešle s těmito hlavičkami:

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

Stavový kód a hlavičky odpovědi se vrátí takto:

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

Kód XML odpovědi na tento požadavek je následující. Všimněte si NextMarker , že element následuje sadu front a obsahuje název další fronty, která se má vrátit.

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

Následující operace seznamu určuje značku identifikátoru URI požadavku následujícím způsobem. Vrátí se další sada výsledků, počínaje frontou určenou značkou. Tady je identifikátor URI pro následující požadavek:

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

Text odpovědi pro tuto operaci je následující:

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

Viz také

Autorizace žádostí do Služby Azure Storage
Stavové kódy a kódy chyb
Kódy chyb služby Queue Storage