Get File
Get File 操作は、メタデータやプロパティなどのファイルをシステムから読み取りまたはダウンロードします。
プロトコルの可用性
| 有効なファイル共有プロトコル | 利用可能 |
|---|---|
| SMB |
|
| NFS |
|
Request
Get File 要求の構成は次のとおりです。 HTTPS を使用することをお勧めします。
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
GET |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile |
HTTP/1.1 |
次のように、要求 URI に表示されるパス コンポーネントを独自のパス コンポーネントに置き換えます。
| パス コンポーネント | 説明 |
|---|---|
myaccount |
ご利用のストレージ アカウントの名前。 |
myshare |
ファイル共有の名前。 |
mydirectorypath |
省略可能。 ディレクトリへのパス。 |
myfile |
ファイルの名前です。 |
パスの名前付け制限の詳細については、「 名前と参照共有、ディレクトリ、ファイル、およびメタデータ」を参照してください。
URI パラメーター
要求 URI には、次の追加パラメーターを指定できます。
| パラメーター | 説明 |
|---|---|
timeout |
省略可能。
timeout パラメーターは、秒単位で表されます。 詳細については、「Azure Files操作のタイムアウトを設定する」を参照してください。 |
要求ヘッダー
必須の要求ヘッダーと省略可能な要求ヘッダーを次の表に示します。
| 要求ヘッダー | 説明 |
|---|---|
Authorization |
必須。 承認スキーム、アカウント名、署名を指定します。 詳細については、「Azure Storage への要求を承認する」をご覧ください。 |
Date または x-ms-date |
必須。 要求に対して協定世界時 (UTC) を指定します。 詳細については、「Azure Storage への要求を承認する」をご覧ください。 |
x-ms-version |
すべての承認された要求に必要です。 この要求に使用する操作のバージョンを指定します。 詳細については、「Azure Storage サービスのバージョン管理」を参照してください。 |
Range |
省略可能。 指定したバイト範囲からのみファイル データを返します。 |
x-ms-range |
省略可能。 指定したバイト範囲からのみファイル データを返します。
Range と x-ms-range の両方が指定されている場合、サービスは x-ms-range の値を使用します。 どちらも指定しない場合は、ファイルの内容全体が返されます。 詳細については、「Azure Files操作の範囲ヘッダーを指定する」を参照してください。 |
x-ms-range-get-content-md5: true |
省略可能。 このヘッダーが に設定され、ヘッダーとRange共にtrue指定されている場合、範囲のサイズが 4 メビバイト (MiB) 以下である限り、サービスは範囲の MD5 ハッシュを返します。このヘッダーが指定され、 Range ヘッダーが指定されていない場合、サービスはステータス コード 400 (Bad Request) を返します。範囲のサイズが 4 MiB を超えたときにこのヘッダーが に true 設定されている場合、サービスは状態コード 400 (無効な要求) を返します。 |
x-ms-lease-id:<ID> |
省略可能。 バージョン 2019-02-02 以降。 ヘッダーが指定されている場合、操作は、ファイルのリースが現在アクティブであり、要求で指定されたリース ID がファイルのリース ID と一致する場合にのみ実行されます。 それ以外の場合、操作は状態コード 412 (前提条件に失敗) で失敗します。 |
x-ms-client-request-id |
省略可能。 ログ記録の構成時にログに記録される 1 kibibyte (KiB) 文字制限を使用して、クライアントによって生成された不透明な値を提供します。 このヘッダーを使用して、クライアント側のアクティビティとサーバーが受信する要求を関連付けるよう強くお勧めします。 詳細については、「Azure Filesの監視」を参照してください。 |
x-ms-file-request-intent |
ヘッダーが OAuth トークンを指定する場合 Authorization は必須。 許容される値は です backup。 このヘッダーは、 ヘッダーをMicrosoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action使用してAuthorization承認された ID に割り当てられた RBAC ポリシーに 含まれている場合に、 または Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action を許可するように指定します。 バージョン 2022-11-02 以降で使用できます。 |
x-ms-allow-trailing-dot: { <Boolean> } |
省略可能。 バージョン 2022-11-02 以降。 ブール値は、要求 URL に存在する末尾のドットをトリミングするかどうかを指定します。 詳細については、「共有、 ディレクトリ、ファイル、およびメタデータの名前付けと参照」を参照してください。 |
要求本文
[なし] :
Response
応答には HTTP ステータス コード、一連の応答ヘッダー、およびファイルのコンテンツを含む応答本文が含まれます。
status code
操作に成功すると、状態コード 200 (OK) が返されます。
状態コードの詳細については、「 状態コードとエラー コード」を参照してください。
応答ヘッダー
この操作の応答には、次のヘッダーが含まれています。 応答には、追加の標準 HTTP ヘッダーも含まれる場合があります。 すべての標準ヘッダーは 、HTTP/1.1 プロトコル仕様に準拠しています。
| 応答ヘッダー | 説明 |
|---|---|
Last-Modified |
ファイルが最後に変更された日時を返します。 日付形式は RFC 1123 に従います。 詳細については、「 ヘッダーの日付/時刻値を表す」を参照してください。 ファイルまたはそのプロパティを変更する操作は、最後に変更された時刻を更新します。 |
x-ms-meta-name:value |
このファイルにユーザー定義メタデータとして関連付けられた名前と値のペアのセット。 |
Content-Length |
応答本文に含まれるバイト数。 |
Content-Type |
ファイルに対して指定されたコンテンツの種類。 既定のコンテンツの種類は application/octet-stream です。 |
Content-Range |
クライアントが要求ヘッダーを設定 Range してファイルのサブセットを要求した場合に返されるバイト範囲。 |
ETag |
条件付きで操作を実行するために使用できる値が含まれています。 値は引用符で囲まれています。 |
Content-MD5 |
ファイルに MD5 ハッシュがあり、要求でファイル全体を読み取る場合は、クライアントがメッセージ コンテンツの整合性をチェックできるようにこの応答ヘッダーが返されます。 要求が指定された範囲 x-ms-range-get-content-md5 を読み取る場合、 が に true設定されている場合、範囲サイズが 4 MiB 以下である限り、要求は範囲の MD5 ハッシュを返します。これらの条件セットのどちらも でない場合、 trueヘッダーの値は返されません Content-MD5 。が range ヘッダーなしで指定されている場合 x-ms-range-get-content-md5 、サービスは状態コード 400 (無効な要求) を返します。が に true設定されている場合x-ms-range-get-content-md5、範囲が 4 MiB を超えると、サービスは状態コード 400 (Bad Request) を返します。 |
Content-Encoding |
要求ヘッダーに指定された値を Content-Encoding 返します。 |
Content-Language |
要求ヘッダーに指定された値を Content-Language 返します。 |
Cache-Control |
ファイルに対して以前に指定されている場合は が返されます。 |
Content-Disposition |
x-ms-content-disposition ヘッダーに指定された値を返し、応答を処理する方法を指定します。応答ヘッダー フィールドは Content-Disposition 、応答ペイロードの処理方法に関する追加情報を伝え、追加のメタデータを添付するために使用することもできます。 たとえば、 が にattachmentContent-Disposition設定されている場合、ユーザー エージェントは応答を表示せず、代わりに [名前を付けて保存] ウィンドウを表示する必要があることを示します。 |
x-ms-request-id |
作成された要求を一意に識別し、要求のトラブルシューティングに使用できます。 詳細については、「 API 操作のトラブルシューティング」を参照してください。 |
x-ms-version |
要求の実行に使用されたサービス バージョン。 |
Accept-Ranges: bytes |
サービスがファイル コンテンツの一部に対する要求をサポートすることを示します。 |
Date |
Date |
x-ms-copy-completion-time:<datetime> |
バージョン 2015-02-21 以降。 最後に試行した ファイルのコピー 操作の終了時刻。このファイルはコピー先ファイルでした。 この値は、完了、中止、または失敗したコピー試行の時刻を示します。 コピーが保留中の場合、このファイルがファイルのコピー操作のコピー先になっていない場合、またはファイルのプロパティの設定またはファイルの作成を使用したファイルのコピー操作が終了した後にこのファイルが変更された場合、このヘッダーは表示されません。 |
x-ms-copy-status-description: <error string> |
バージョン 2015-02-21 以降。
失敗または保留中の場合x-ms-copy-statusにのみ表示されます。 致命的または致命的でないコピー操作エラーの原因について説明します。 このヘッダーは、このファイルがファイルのコピー操作のコピー先になっていない場合、またはファイルのプロパティの設定またはファイルの作成を使用したファイルのコピー操作が終了した後にこのファイルが変更された場合は表示されません。 |
x-ms-copy-id: <id> |
バージョン 2015-02-21 以降。 最後に試行した ファイルのコピー 操作の文字列識別子。このファイルはコピー先ファイルでした。 このヘッダーは、ファイルがファイルのコピー操作のコピー先になっていない場合、またはファイルのプロパティの設定またはファイルの作成を使用したファイルのコピー操作が終了した後にこのファイルが変更された場合は表示されません。 |
x-ms-copy-progress: <bytes copied/bytes total> |
バージョン 2015-02-21 以降。 コピーされたバイト数と、このファイルがコピー先ファイルであった最後に試行された ファイルのコピー 操作のソース内の合計バイト数が含まれます。 0 からコピーされた Content-Length バイト数までを表示できます。 このヘッダーは、このファイルがファイルのコピー操作のコピー先になっていない場合、またはファイルのプロパティの設定またはファイルの作成を使用したファイルのコピー操作が終了した後にこのファイルが変更された場合は表示されません。 |
x-ms-copy-source: url |
バージョン 2015-02-21 以降。 このファイルがコピー先ファイルであった最後に試行されたファイルの コピー 操作で使用されたソース ファイルを指定する、最大 2 KB の長さの URL。 このヘッダーは、このファイルがファイルのコピー操作のコピー先になっていない場合、またはファイルのプロパティの設定またはファイルの作成を使用したファイルのコピー操作が終了した後にこのファイルが変更された場合は表示されません。 |
x-ms-copy-status: <pending ¦ success ¦ aborted ¦ failed> |
バージョン 2015-02-21 以降。 で x-ms-copy-id識別されるコピー操作の状態と、次の値を指定します。- pending: コピーが進行中です。 断続的で致命的でないエラーがコピーの進行状況を妨げるが、エラーが発生しないかどうかを確認 x-ms-copy-status-description します。- success: コピーが正常に完了しました。- aborted: コピーは、コピー ファイルの中止によって終了しました。- failed: コピーに失敗しました。 エラーの詳細については、「x-ms-copy-status-description」を参照してください。このヘッダーは、このファイルがファイルのコピー操作のコピー先になっていない場合、またはファイルのプロパティの設定またはファイルの作成を使用したファイルのコピー操作の完了後にこのファイルが変更された場合は表示されません。 |
x-ms-content-md5 |
バージョン 2016-05-31 の時点で、ファイルに MD5 ハッシュがあり、要求に範囲ヘッダー (range または x-ms-range) が含まれている場合、この応答ヘッダーはファイル全体の MD5 値の値と共に返されます。 この値は、要求された範囲から計算されるヘッダーで Content-MD5 返される値と等しい場合と等しくない場合があります。 |
x-ms-server-encrypted: true/false |
バージョン 2017-04-17 以降。 指定したアルゴリズムを true 使用してファイル データとアプリケーション メタデータが完全に暗号化されている場合、このヘッダーの値は に設定されます。 ファイルが暗号化されていない場合、またはファイル/アプリケーション メタデータの一部のみが暗号化されている場合、値は に false設定されます。 |
x-ms-file-permission-key |
ファイルのアクセス許可のキー。 |
x-ms-file-attributes |
ファイルのファイル システム属性。 詳細については、 使用可能な属性の一覧を参照してください。 |
x-ms-file-creation-time |
ファイルの作成時刻プロパティを表す UTC 日付/時刻値。 |
x-ms-file-last-write-time |
ファイルの最後の書き込み時刻プロパティを表す UTC 日付/時刻値。 |
x-ms-file-change-time |
ファイルの変更時刻プロパティを表す値の UTC 日付/時刻。 |
x-ms-file-file-id |
ファイルのファイル ID。 |
x-ms-file-parent-id |
ファイルの親ファイル ID。 |
x-ms-lease-duration:infinite |
バージョン 2019-02-02 以降。 ファイルがリースされるときに、リースが無限の期間であることを指定します。 |
x-ms-lease-state: <available, leased, broken> |
バージョン 2019-02-02 以降。 ファイルがリースされるときに、ファイルのリース状態を指定します。 |
x-ms-lease-status: <locked, unlocked> |
バージョン 2019-02-02 以降。 ファイルがリースされるときに、ファイルのリース状態を指定します。 |
x-ms-client-request-id |
要求とそれに対応する応答のトラブルシューティングに使用できます。 このヘッダーの値は、要求に存在し、その値に 1,024 文字以下の ASCII 文字が含まれている場合、ヘッダーの値 x-ms-client-request-id と等しくなります。 ヘッダーが x-ms-client-request-id 要求に存在しない場合は、応答に存在しません。 |
応答本文
応答本文には、ファイルの内容が含まれています。
応答のサンプル
Response Status:
HTTP/1.1 200 OK
Response Headers:
x-ms-type: File
x-ms-meta-m1: v1
x-ms-meta-m2: v2
Content-Length: 11
Content-Type: text/plain; charset=UTF-8
Date: <date>
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: <date>
x-ms-version: 2019-02-02
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
x-ms-copy-id: 36650d67-05c9-4a24-9a7d-a2213e53caf6
x-ms-copy-source: <url>
x-ms-copy-status: success
x-ms-copy-progress: 11/11
x-ms-copy-completion-time: <date>
x-ms-lease-duration: infinite
x-ms-lease-state: leased
x-ms-lease-status: locked
承認
この操作を呼び出すことができるのはアカウント所有者のみです。
解説
まだコンテンツを持っていない、またはクリアされた範囲を呼び出 Get File すと、それらのバイトが 0 返されます。
範囲を指定せず を呼び出 Get File した場合、サービスはヘッダーに指定された値までのバイト範囲を x-ms-content-length 返します。 コンテンツがない範囲の場合、サービスはこれらのバイトに対して を返します 0 。
Get File MiB ごとに 2 分間の操作を完了できます。 MiB あたり平均で 2 分を超える時間がかかる操作はタイムアウトになります。