この記事は機械翻訳されています。英語版の記事を表示するには、[英語] のチェック ボックスをオンにしてください。また、テキストにマウス ポインターを合わせると、ポップアップ ウィンドウに英語のテキストを表示することもできます。
翻訳
英語

List Queues

 

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

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

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

Parameter

description

prefix

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

marker

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

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

maxresults

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

include=metadata

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

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

timeout

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

次の表は、必須の要求ヘッダーおよび省略可能な要求ヘッダーを示します。

要求ヘッダー

description

Authorization

必須。

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

Date または x-ms-date

必須。

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

x-ms-version

省略可能です。 この要求に使用する操作のバージョンを指定します。 詳細については、次を参照してください。 Windows Azure の BLOB サービス、キュー サービス、およびテーブル サービスのバージョン管理です。

x-ms-client-request-id

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

ありません。

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

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

操作に成功すると、状態コード 200 (OK) が返されます。

状態コードについては、次を参照してください。 ステータス コードとエラー コードです。

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

応答ヘッダー

description

x-ms-request-id

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

x-ms-version

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

Date

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

応答本文の形式は次のとおりです。 なお、 Prefix, 、Marker, 、および MaxResults 要素は、URI で指定された場合にのみです。 NextMarker 要素には、値がある結果のリストが不完全な場合にのみです。

バージョン 2013年-08-15 以降では、 AccountName 属性を EnumerationResults に要素が変更されました 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 バージョンによって適用される名前付けの制約に違反する場合、 x-ms-invalid-name 要素は、次の XML フラグメントで示すようにします。


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

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

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

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

値の 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>
表示: