エクスポート (0) 印刷
すべて展開

List Queues

更新日: 2013年11月

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

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

 

メソッド 要求 URI HTTP バージョン

GET

https://myaccount.queue.core.windows.net?comp=list

HTTP/1.1

エミューレートされたストレージ サービスに対する要求では、エミュレーターのホスト名とキュー サービス ポートを 127.0.0.1:10001 と指定し、その後にエミューレートされたストレージ アカウント名を指定します。

 

メソッド 要求 URI HTTP バージョン

GET

http://127.0.0.1:10001/devstoreaccount1?comp=list

HTTP/1.1

詳細については、「About Development Storage」を参照してください。

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

 

Parameter 説明

prefix

結果をフィルター処理して、名前が指定したプレフィックスで開始するキューのみ返します。

marker

次の一覧操作で返される一覧の部分を識別する文字列値です。返される一覧が完全ではなかった場合は、応答本文に NextMarker 要素が返されます。この値は、キューの一覧の次の部分を要求する後続の呼び出しで、クエリ パラメーターとして使用することができます。

マーカー値はクライアントに対して非透過的です。

maxresults

返されるキューの最大数を指定します。maxresults が指定されていない場合、サーバーは最大 5,000 項目を返します。

include=metadata

省略可能。コンテナーのメタデータが応答本文の一部として返されるように指定するには、このパラメーターを使用します。

このパラメーターで要求されたメタデータは、2009-09-19 バージョンのキュー サービスで設定されている名前付けの制約に従って格納する必要があります。このバージョン以降では、すべてのメタデータの名前は C# 識別子の名前付け規則に従う必要があります。

timeout

省略可能。timeout パラメーターは、秒単位で表されます。詳細については、「キュー サービス操作のタイムアウトの設定」を参照してください。

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

 

要求ヘッダー 説明

Authorization

必須。認証スキーム、アカウント名、および署名を指定します。詳細については、「Azure ストレージ サービスの認証」を参照してください。

Date またはx-ms-date

必須。要求の世界協定時刻 (UTC) を指定します。詳細については、「Azure ストレージ サービスの認証」を参照してください。

x-ms-version

省略可能。この要求に使用する操作のバージョンを指定します。詳細については、「Azure ストレージ サービスのバージョン設定」を参照してください。

x-ms-client-request-id

省略可能。Storage Analytics Logging が有効な場合に解析ログに記録される、クライアントで生成された非透過の値を 1 KB の文字制限付きで提供します。クライアント側のアクティビティとサーバーが受け取る要求を相互に関連付けるには、このヘッダーを使用することを強くお勧めします。詳細については、「Storage Analytics Logging について」および「Windows Azure のログ: ログを使用した、ストレージ要求の追跡」を参照してください。

なし。

要求例については、「要求と応答の例」のセクションを参照してください。

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

操作が正常に終了すると、ステータス コード 200 (OK) が返されます。

ステータス コードの詳細については、「ステータス コードとエラー コード」を参照してください。

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

 

応答ヘッダー 説明

x-ms-request-id

このヘッダーは要求を一意に識別するので、要求のトラブルシューティングに使用できます。詳細については、「API 操作のトラブルシューティング」を参照してください。

x-ms-version

要求の実行に使用するキュー サービスのバージョンを示します。このヘッダーはバージョン 2009-09-19 以降で行った要求に対して返されます。

Date

サービスによって生成される、応答の開始時刻を示す UTC 日付/時刻値。

応答本文の形式は次のとおりです。PrefixMarkerMaxResults の各要素は、URI で指定された場合にのみ存在します。NextMarker 要素は、一覧結果が不完全な場合にのみ値を持ちます。

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

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

表示:
© 2014 Microsoft