共有の統計の取得

  • [アーティクル]

要求は Get Share Stats 、共有に関連する統計を取得します。 この API は完全にサポートされていますが、レガシ管理 API です。 このため、代わりに、ストレージ リソース プロバイダー (Microsoft.Storage) によって提供される ファイル共有 - Get を使用することをお勧めします。

ストレージ リソース プロバイダーを使用してプログラムでリソースをFileShare操作する方法の詳細については、「Azure Files共有に対する操作」を参照してください。

プロトコルの可用性

有効なファイル共有プロトコル 利用可能
SMB はい
NFS はい

要求

Get Share Stats 要求の構成は次のとおりです。 HTTPS を使用することをお勧めします。 myaccount をストレージ アカウントの名前に置き換え、myshare を共有の名前に置き換えます。

Method 要求 URI HTTP バージョン
GET https://myaccount.file.core.windows.net/myshare?restype=share&comp=stats HTTP/1.1

URI パラメーター

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

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

要求ヘッダー

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

要求ヘッダー 説明
Authorization 必須。 承認スキーム、アカウント名、署名を指定します。 詳細については、「Azure Storage への要求を承認する」をご覧ください。
Date または x-ms-date 必須。 要求に対して協定世界時 (UTC) を指定します。 詳細については、「Azure Storage への要求を承認する」をご覧ください。
x-ms-version すべての承認された要求に必要です。 バージョン 2015-02-21 以降。 この要求に使用する操作のバージョンを指定します。

詳細については、「Azure Storage サービスのバージョン管理」を参照してください。
x-ms-client-request-id 省略可能。 ログ記録の構成時にログに記録される 1 kibibyte (KiB) 文字制限を使用して、クライアントによって生成された不透明な値を提供します。 このヘッダーを使用して、クライアント側のアクティビティとサーバーが受信する要求を関連付けるよう強くお勧めします。 詳細については、「Azure Filesの監視」を参照してください。
x-ms-lease-id:<ID> 省略可能。 バージョン 2020-02-10 以降。 ヘッダーが指定されている場合、ファイル共有のリースが現在アクティブで、要求で指定されたリース ID がファイル共有のリース ID と一致する場合にのみ、操作が実行されます。 一致しない場合、操作は状態コード 412 (前提条件に失敗) で失敗します。

要求本文

なし。

[応答]

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

状態コード

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

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

応答ヘッダー

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

応答ヘッダー 説明
Last-Modified 共有が最後に変更された日時を返します。 日付形式は RFC 1123 に従います。 詳細については、「 ヘッダーの日付/時刻値を表す」を参照してください。 共有またはそのプロパティを変更する操作を行うと、最終更新時刻が更新されます。 ファイルに対する操作は、共有の最終更新時刻に影響しません。
ETag 条件付きで操作を実行するために使用できる値が含まれます。 値は引用符で囲まれています。
x-ms-request-id 作成された要求を一意に識別し、要求のトラブルシューティングに使用できます。 詳細については、「 API 操作のトラブルシューティング」を参照してください。
x-ms-version 要求の実行に使用されたAzure Filesバージョンを示します。
Date サービスによって生成される UTC 日付/時刻値。応答が開始された時刻を示します。
x-ms-client-request-id 要求とそれに対応する応答のトラブルシューティングに使用できます。 このヘッダーの値は、要求に存在し、その値に 1,024 文字以下の ASCII 文字が含まれている場合、ヘッダーの値 x-ms-client-request-id と等しくなります。 ヘッダーが x-ms-client-request-id 要求に存在しない場合、応答には存在しません。

応答本文

応答本文の形式は次のとおりです。

<?xml version="1.0" encoding="utf-8"?>  
<ShareStats>  
   <ShareUsageBytes>8189134192</ShareUsageBytes>  
</ShareStats>
要素 説明
ShareUsageBytes 共有に格納されているデータのおおよそのサイズ。 この値には、最近作成または最近サイズ変更されたすべてのファイルが含まれていない場合があることに注意してください。

承認

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

注釈

共有スナップショットの統計情報を取得できません。 共有スナップショット統計を取得しようとすると、サービスは状態コード 400 (無効なクエリ パラメーター値) を返します。

バージョン 2018-11-09 の時点で、 ShareUsage 応答要素は に ShareUsageBytes置き換えられました。 ShareUsage は、共有に格納されているデータのおおよそのサイズで、最も近いギビバイト (GiB) に切り上げられます。

関連項目

Azure ファイル共有に対する操作