Get Queue Service Properties

  • [アーティクル]

この操作ではGet Queue Service Properties、Storage Analyticsおよびクロスオリジン リソース共有 (CORS) ルールのプロパティを含む、Azure Queue Storage アカウントのプロパティを取得します。

クロスオリジン リソース共有 (CORS) ルールと評価ロジックの詳細については、 Azure Storage サービスの CORS サポートに関するページを参照してください。

要求

Get Queue Service Properties要求は、次のように指定できます。 HTTPS を使用することをお勧めします。 account-name> をストレージ アカウントの名前に置き換えます<。

Method 要求 URI HTTP バージョン
GET https://<account-name>.queue.core.windows.net/?restype=service&comp=properties HTTP/1.1

注意

URI のパスとクエリ部分からホスト名を分離するには、URI には常にスラッシュ文字 (/) を含める必要があります。 この操作では、URI のパス部分が空です。

URI パラメーター

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

パラメーター 説明
restype=service&comp=properties 必須。 ストレージ サービス プロパティを取得するには、両方のクエリ文字列を組み合わせる必要があります。
timeout 省略可能。 timeout パラメーターは、秒単位で表されます。 詳細については、「 Azure Queue Storage 操作のタイムアウトを設定する」を参照してください。

要求ヘッダー

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

要求ヘッダー 説明
Authorization 必須。 承認スキーム、ストレージ アカウント名、署名を指定します。 詳細については、「Azure Storage への要求を承認する」をご覧ください。
Date または x-ms-date 必須。 要求に対して協定世界時 (UTC) を指定します。 詳細については、「Azure Storage への要求を承認する」をご覧ください。
x-ms-version すべての承認された要求に必要です。 この要求に使用する操作のバージョンを指定します。 詳細については、「Azure Storage サービスのバージョン管理」を参照してください。
x-ms-client-request-id 省略可能。 ログ記録の構成時にログに記録される 1 kibibyte (KiB) 文字制限を使用して、クライアントによって生成された不透明な値を提供します。 このヘッダーを使用して、クライアント側のアクティビティとサーバーが受信する要求を関連付けるよう強くお勧めします。 詳細については、「 Azure Queue Storage の監視」を参照してください。

要求本文

なし。

[応答]

応答には、HTTP 状態コード、一連の応答ヘッダー、および応答本文が含まれています。

状態コード

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

応答ヘッダー

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

応答ヘッダー 説明
x-ms-request-id サービスに対して行われた要求を一意に識別します。
x-ms-version 要求に対して使用される操作のバージョンを指定します。 詳細については、「Azure Storage サービスのバージョン管理」を参照してください。
x-ms-client-request-id 要求と対応する応答のトラブルシューティングに使用できます。 このヘッダーの値 x-ms-client-request-id は、要求に存在し、値に 1,024 文字以下の ASCII 文字が含まれている場合、ヘッダーの値と同じです。 ヘッダーが x-ms-client-request-id 要求に存在しない場合、応答には存在しません。

応答本文

バージョン 2012-02-12 以前では、応答本文の形式は次のとおりです。

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <Logging>  
        <Version>version-number</Version>  
        <Delete>true|false</Delete>  
        <Read>true|false</Read>  
        <Write>true|false</Write>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </Logging>  
    <Metrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </Metrics>  
</StorageServiceProperties>

バージョン 2013-08-15 の時点では、応答本文の形式は次のとおりです。

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <Logging>  
        <Version>version-number</Version>  
        <Delete>true|false</Delete>  
        <Read>true|false</Read>  
        <Write>true|false</Write>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </Logging>  
    <HourMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </HourMetrics>  
    <MinuteMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </MinuteMetrics>  
    <Cors>  
        <CorsRule>  
            <AllowedOrigins>comma-separated-list-of-allowed-origins</AllowedOrigins>  
            <AllowedMethods>comma-separated-list-of-HTTP-verb</AllowedMethods>  
            <MaxAgeInSeconds>max-caching-age-in-seconds</MaxAgeInSeconds>  
            <ExposedHeaders>comma-separated-list-of-response-headers</ExposedHeaders>  
            <AllowedHeaders> comma-separated-list-of-request-headers </AllowedHeaders>  
        </CorsRule>  
    </Cors>  
</StorageServiceProperties>

応答本文の要素を次の表に示します。

要素名 説明
Logging Storage Analyticsログ設定をグループにします。
Metrics Storage Analyticsメトリック設定をグループにします。 Metrics 設定によって、キューの 1 時間ごとの集計で API 別にグループ化された要求の統計に関する概要が示されます。
HourMetrics Storage Analytics HourMetrics 設定をグループにします。 HourMetrics 設定によって、キューの 1 時間ごとの集計で API 別にグループ化された要求の統計に関する概要が示されます。
MinuteMetrics Storage Analytics MinuteMetrics* 設定をグループにします。 MinuteMetrics 設定によって、キューの分単位の要求の統計が示されます。
Version 現在使用されているStorage Analyticsのバージョン。
削除 ログ構成にのみ適用されます。 削除要求をログに記録するかどうかを示します。
読み取り ログ構成にのみ適用されます。 読み取り要求をログに記録するかどうかを示します。
書き込み ログ構成にのみ適用されます。 書き込み要求をログに記録するかどうかを示します。
有効 Azure Queue Storage に対してメトリックが有効になっているかどうかを示します。

読み取りアクセスの地理冗長レプリケーションが有効である場合、プライマリ メトリックとセカンダリ メトリックの両方が収集されます。 読み取りアクセスの地理冗長レプリケーションが有効でない場合、プライマリ メトリックだけが収集されます。
IncludeAPIs メトリック構成にのみ適用されます。 メトリックで、呼び出された API 操作の概要統計情報を生成するかどうかを示します。
RetentionPolicy/Enabled ストレージ サービスに対して保持ポリシーが有効であるかどうかを示します。
RetentionPolicy/Days メトリックまたはログ データを保持する日数を示します。 この値より古いデータは、すべて削除されます。
Cors すべての CORS ルールをグループ化します。
CorsRule CORS ルールの設定をグループ化します。
AllowedOrigins CORS 経由で許可される配信元ドメインのコンマ区切りの一覧。すべてのドメインが許可されている場合はアスタリスク (*)。
ExposedHeaders CORS クライアントに公開されている応答ヘッダーのコンマ区切りのリストです。
MaxAgeInSeconds クライアントまたはブラウザーがプレフライト応答をキャッシュする秒数。
AllowedHeaders クロスオリジン要求の一部として許可されるヘッダーのコンマ区切りのリスト。
AllowedMethods 元のドメインによる実行が許可される HTTP メソッドのコンマ区切りのリストです。 Azure Storage の場合、許可されるメソッドは DELETE、GET、HEAD、MERGE、POST、OPTIONS、または PUT です。

承認

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

要求と応答の例

次の URI の例では、架空のストレージ アカウント名 myaccount のキュー サービス プロパティを取得するように要求します。

GET https://myaccount.queue.core.windows.net/?restype=service&comp=properties HTTP/1.1

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

x-ms-version: 2013-08-15  
x-ms-date: Wed, 23 Oct 2013 04:49:03 GMT  
Authorization: SharedKey  
myaccount:Z1lTLDwtq5o1UYQluucdsXk6/iB7YxEu0m6VofAEkUE=  
Host: myaccount.queue.core.windows.net

要求が送信された後、次の応答が返されます。

HTTP/1.1 200 OK  
Content-Length: 1020  
Content-Type: application/xml  
Date: Wed, 23 Oct 2013 04:49:04 GMT  
Server: Windows-Azure-Queue/1.0 Microsoft-HTTPAPI/2.0  
x-ms-request-id: cb939a31-0cc6-49bb-9fe5-3327691f2a30  
x-ms-version: 2013-08-15

応答本文は次のようになります。

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <Logging>  
        <Version>1.0</Version>  
        <Delete>true</Delete>  
        <Read>false</Read>  
        <Write>true</Write>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </Logging>  
    <HourMetrics>  
        <Version>1.0</Version>  
        <Enabled>true</Enabled>  
        <IncludeAPIs>false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </HourMetrics>  
        <MinuteMetrics>  
        <Version>1.0</Version>  
        <Enabled>true</Enabled>  
        <IncludeAPIs>true</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </MinuteMetrics>  
    <Cors>  
        <CorsRule>  
            <AllowedOrigins> http://www.fabrikam.com,http://www.contoso.com</AllowedOrigins>  
            <AllowedMethods>GET,PUT</AllowedMethods>  
            <MaxAgeInSeconds>500</MaxAgeInSeconds>  
            <ExposedHeaders>x-ms-meta-data*,x-ms-meta-customheader</ExposedHeaders>  
            <AllowedHeaders>x-ms-meta-target*,x-ms-meta-customheader</AllowedHeaders>  
        </CorsRule>  
    </Cors>  
</StorageServiceProperties>

関連項目

Storage Analytics
Azure Storage サービスの CORS サポート
CORS HTTP の仕様