Üzenetsorok listázása

Cikk
08/05/2023

Ez a művelet egy adott tárfiók összes üzenetsorát listázza.

Kérés

A kérést az List Queues alábbiak szerint hozhatja létre. A HTTPS használata ajánlott. Cserélje le a myaccount kifejezést a tárfiók nevére.

Metódus	Kérés URI-ja	HTTP-verzió
`GET`	`https://myaccount.queue.core.windows.net?comp=list`	HTTP/1.1

Emulált tárolási szolgáltatás URI-ja

Amikor kérést küld az emulált tárolási szolgáltatásra, adja meg az emulátor gazdanevét és az Azure Queue Storage-portot 127.0.0.1:10001, majd az emulált tárfiók nevét.

Metódus	Kérés URI-ja	HTTP-verzió
`GET`	`http://127.0.0.1:10001/devstoreaccount1?comp=list`	HTTP/1.1

URI-paraméterek

A kérelem URI-ján a következő további paramétereket adhatja meg.

Paraméter	Leírás
`prefix`	Szűri az eredményeket, hogy csak a megadott előtaggal kezdődő neveket tartalmazó üzenetsorokat adja vissza.
`marker`	A következő listaművelettel visszaadandó listarészt azonosító sztringérték. A művelet egy `NextMarker` elemet ad vissza a válasz törzsében, ha a visszaadott lista nem fejeződött be. Ezt az értéket ezután lekérdezési paraméterként használhatja egy későbbi hívásban az üzenetsorok listájának következő részének lekéréséhez. A jelölő értéke átlátszatlan az ügyfél számára.
`maxresults`	A visszaadandó üzenetsorok maximális számát adja meg. Ha `maxresults` nincs megadva, a kiszolgáló legfeljebb 5000 elemet ad vissza.
`include=metadata`	Választható. Adja meg ezt a paramétert annak megadásához, hogy a tároló metaadatai a választörzs részeként legyenek visszaadva. Vegye figyelembe, hogy az ezzel a paraméterrel kért metaadatokat a Queue Storage 2009-09-19 verziójának elnevezési korlátozásaival összhangban kell tárolni. Ezzel a verzióval kezdődően minden metaadatnévnek meg kell felelnie a C#-azonosítók elnevezési konvencióinak.
`timeout`	Választható. A `timeout` paraméter másodpercben van kifejezve. További információ: Időtúllépések beállítása a Queue Storage-műveletekhez.

Kérésfejlécek

Az alábbi táblázat a szükséges és nem kötelező kérelemfejléceket ismerteti.

Kérelem fejléce	Leírás
`Authorization`	Kötelező. Megadja az engedélyezési sémát, a fióknevet és az aláírást. További információ: Kérelmek engedélyezése az Azure Storage-ba.
`Date` vagy `x-ms-date`	Kötelező. Megadja a kérés egyezményes világidő (UTC) formátumban kifejezett időpontját. További információ: Kérelmek engedélyezése az Azure Storage-ba.
`x-ms-version`	Választható. A kérelemhez használandó művelet verzióját adja meg. További információ: Az Azure Storage-szolgáltatások verziószámozása.
`x-ms-client-request-id`	Választható. Ügyfél által generált, átlátszatlan értéket biztosít egy 1 kibibyte (KiB) karakterkorláttal, amelyet a naplózás konfigurálásakor rögzít a naplókban. Javasoljuk, hogy ezt a fejlécet használva korrelálja az ügyféloldali tevékenységeket a kiszolgáló által kapott kérésekkel. További információ: Az Azure Queue Storage monitorozása.

A kérés törzse

Nincsenek.

Mintakérés

A cikk későbbi részében tekintse meg a "Mintakérés és válasz" című szakaszt.

Reagálás

A válasz tartalmaz egy HTTP-állapotkódot, egy válaszfejléceket és egy választörzset, amely tartalmazza az üzenetsorok listáját.

Állapotkód

A sikeres művelet a 200 -os állapotkódot adja vissza (OK). Az állapotkódokkal kapcsolatos információkért lásd: Állapot- és hibakódok.

Válaszfejlécek

A műveletre adott válasz a következő fejléceket tartalmazza. A válasz további szabványos HTTP-fejléceket is tartalmazhat. Minden szabványos fejléc megfelel a HTTP/1.1 protokoll specifikációjának.

Válaszfejléc	Description
`x-ms-request-id`	Ez a fejléc egyedileg azonosítja a végrehajtott kérést, és a kérés hibaelhárításához használható. További információ: API-műveletek hibaelhárítása.
`x-ms-version`	A Kérés futtatásához használt Queue Storage-verziót jelzi. Ez a fejléc lesz visszaadva a 2009-09-19-es és újabb verzióval kapcsolatos kérésekhez.
`Date`	UTC dátum/idő érték, amely a válasz indításának időpontját jelzi. Ezt az értéket a szolgáltatás hozza létre.
`x-ms-client-request-id`	Ezzel a fejléccel elháríthatja a kéréseket és a megfelelő válaszokat. Ennek a fejlécnek az értéke megegyezik a `x-ms-client-request-id` fejléc értékével, ha az szerepel a kérelemben. Az érték legfeljebb 1024 látható ASCII-karakter lehet. Ha a `x-ms-client-request-id` fejléc nem szerepel a kérelemben, akkor ez a fejléc nem jelenik meg a válaszban.

Választörzs

A válasz törzsének formátuma a következő. Vegye figyelembe, hogy a Prefix, Markerés MaxResults elem csak akkor jelenik meg, ha megadta őket az URI-n. Az NextMarker elem csak akkor rendelkezik értékkel, ha a listaeredmények nem fejeződnek be.

A 2013-08-15-ös és újabb verziókban az AccountNameEnumerationResults elem attribútuma átnevezve a következőre ServiceEndpoint: . Emellett a Url (z) elem Queue el lett távolítva.

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

Az Metadata elem csak akkor jelenik meg, ha a include=metadata paraméter meg lett adva az URI-n. Az elemen belül az Metadata egyes név-érték párok értéke a pár nevének megfelelő elemen belül jelenik meg.

Ha egy metaadat-név-érték pár megsérti a 2009-09-19-es verzió által kikényszerített elnevezési korlátozásokat, a válasz törzse jelzi a problémás nevet egy x-ms-invalid-name elemen belül, ahogyan az a következő XML-töredékben látható:

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

Mintaválasz

A cikk későbbi részében tekintse meg a "Mintakérés és válasz" című szakaszt.

Engedélyezés

Ezt a műveletet csak a fióktulajdonos hívhatja meg.

Megjegyzések

Ha megad egy értéket a maxresults paraméterhez, és a visszaadandó üzenetsorok száma meghaladja ezt az értéket, vagy meghaladja a paraméter alapértelmezett értékét maxresults, a választörzs tartalmaz egy NextMarker elemet. Ez az elem a következő üzenetsort jelzi, amely egy későbbi kérés esetén tér vissza. A következő elemkészlet visszaadásához adja meg a jelölőparaméter értékét NextMarker az URI-n a következő kéréshez.

Vegye figyelembe, hogy az értékét NextMarker átlátszatlanként kell kezelni.

Az üzenetsorok betűrendben jelennek meg a válasz törzsében.

Mintakérés és válasz

Íme egy minta URI, amely egy fiók üzenetsorainak listáját kéri le. A kezdeti művelet maximális eredményét háromra állítja vissza.

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

A rendszer a következő fejlécekkel küldi el a kérést:

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

Az állapotkód és a válaszfejlécek a következőképpen lesznek visszaadva:

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

A kérés válasz XML-je a következő. Vegye figyelembe, hogy az NextMarker elem az üzenetsorok halmazát követi, és tartalmazza a következő visszaadandó üzenetsor nevét.

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

Az ezt követő listaművelet az alábbiak szerint határozza meg a jelölőt a kérelem URI-ján. A rendszer a következő eredményhalmazt adja vissza, kezdve a jelölő által megadott üzenetsorsal. A következő kérés URI-ja:

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

A művelet választörzse a következő:

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

Lásd még

Kérések engedélyezése az Azure Storage-ba
Állapot- és hibakódok
Queue Storage-hibakódok