キューを一覧表示する

この操作では、特定のストレージ アカウント内のすべてのキューが一覧表示されます。

要求

要求は List Queues 次のように構築できます。 HTTPS が推奨されます。 myaccount をストレージ アカウントの名前に置き換えます。

エミュレートされたストレージ サービス URI

エミュレートされたストレージ サービスに対して要求を行う場合は、エミュレーターのホスト名と Azure Queue Storage ポートを として 127.0.0.1:10001指定し、その後にエミュレートされたストレージ アカウント名を指定します。

URI パラメーター

要求 URI には、次の追加パラメーターを指定できます。

要求ヘッダー

必須要求ヘッダーと省略可能な要求ヘッダーを次の表に示します。

要求本文

なし。

要求のサンプル

この記事で後述する「要求と応答のサンプル」セクションを参照してください。

[応答]

応答には HTTP ステータス コード、一連の応答ヘッダー、およびキューの一覧を含む応答本文が含まれます。

状態コード

操作に成功すると、状態コード 200 (OK) が返されます。 状態コードの詳細については、「 状態とエラー コード」を参照してください。

応答ヘッダー

この操作の応答には、次のヘッダーが含まれています。 応答には、追加の標準 HTTP ヘッダーを含めることもできます。 すべての標準ヘッダーは 、HTTP/1.1 プロトコル仕様に準拠しています。

応答本文

応答本文の形式は次のとおりです。 、Marker、Prefixおよび MaxResults 要素は、URI で指定した場合にのみ存在します。 要素には NextMarker 、リストの結果が完了していない場合にのみ値があります。

バージョン 2013-08-15 以降では、 要素の AccountNameEnumerationResults 属性の名前が に ServiceEndpoint変更されました。 また、Url の Queue 要素が削除されました。

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

Metadata 要素は、include=metadata パラメーターが URI に指定された場合にのみ存在します。 Metadata 要素内では、名前と値の各ペアの値が、ペアの名前に対応する要素内に一覧表示されます。

メタデータの名前と値のペアが 2009-09-19 バージョンで設定されている名前付けの制約に違反する場合、次の XML フラグメントに示すように、応答本文は x-ms-invalid-name 要素内に問題のある名前を示します。

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

応答のサンプル

この記事で後述する「要求と応答のサンプル」セクションを参照してください。

承認

この操作を呼び出すことができるのは、アカウント所有者だけです。

注釈

パラメーターの値 maxresults を指定し、返すキューの数がこの値を超えている場合、または の既定値 maxresultsを超えている場合、応答本文には 要素が NextMarker 含まれます。 この要素は、後続の要求で返される次のキューを示します。 次の項目セットを返すには、後続の要求の URI で NextMarker の値をマーカー パラメーターとして指定します。

NextMarker の値は非透過的に扱う必要があります。

キューは、応答本文でアルファベット順に一覧表示されます。

要求と応答の例

アカウントのキューの一覧を要求するサンプル URI を次に示します。 最初の操作で返される最大結果を 3 に設定します。

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

要求は次のヘッダーと共に送信されます。

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

ステータス コードと応答ヘッダーは次のように返されます。

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  

この要求の応答 XML は次のとおりです。 要素は NextMarker キューのセットに従い、返される次のキューの名前が含まれていることに注意してください。

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

後続の一覧操作では、次のように要求の URI にマーカーを指定します。 マーカーで指定されたキューから始まる次の結果セットが返されます。 後続の要求の URI を次に示します。

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

この操作の応答本文は次のとおりです。

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

関連項目

Azure Storage への要求を承認する
状態コードとエラー コード
キュー ストレージのエラー コード