Dapatkan File
Operasi membaca Get File atau mengunduh file dari sistem, termasuk metadata dan propertinya.
Ketersediaan protokol
| Mengaktifkan protokol berbagi file | Tersedia |
|---|---|
| SMB |  |
| NFS |  |
Minta
Permintaan Get File dapat dibuat sebagai berikut. Kami menyarankan agar Anda menggunakan HTTPS.
| Metode | Meminta URI | Versi HTTP |
|---|---|---|
GET |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile |
HTTP/1.1 |
Ganti komponen jalur yang ditampilkan dalam URI permintaan dengan milik Anda sendiri, sebagai berikut:
| Komponen jalur | Deskripsi |
|---|---|
myaccount |
Nama akun penyimpanan Anda. |
myshare |
Nama berbagi file Anda. |
mydirectorypath |
Pilihan. Jalur ke direktori. |
myfile |
Nama file. |
Untuk informasi tentang pembatasan penamaan jalur, lihat Berbagi nama dan referensi, direktori, file, dan metadata.
Parameter URI
Parameter tambahan berikut dapat ditentukan pada permintaan URI:
| Parameter | Deskripsi |
|---|---|
timeout |
Opsional. Parameter timeout dinyatakan dalam hitung detik. Untuk informasi selengkapnya, lihat Mengatur batas waktu untuk operasi Azure Files. |
Header permintaan
Header permintaan yang diperlukan dan opsional dijelaskan dalam tabel berikut:
| Meminta kop | Deskripsi |
|---|---|
Authorization |
Wajib diisi. Menentukan skema otorisasi, nama akun, dan tanda tangan. Untuk informasi selengkapnya, lihat Mengotorisasi permintaan ke Azure Storage. |
Date atau x-ms-date |
Wajib diisi. Menentukan Waktu Universal Terkoordinasi (UTC) untuk permintaan tersebut. Untuk informasi selengkapnya, lihat Mengotorisasi permintaan ke Azure Storage. |
x-ms-version |
Diperlukan untuk semua permintaan yang diotorisasi. Menentukan versi operasi yang akan digunakan untuk permintaan ini. Untuk informasi selengkapnya, lihat Penerapan versi untuk layanan Azure Storage. |
Range |
Opsional. Mengembalikan data file hanya dari rentang byte yang ditentukan. |
x-ms-range |
Pilihan. Mengembalikan data file hanya dari rentang byte yang ditentukan. Jika dan Rangex-ms-range ditentukan, layanan menggunakan nilai x-ms-range. Jika tidak ditentukan, seluruh konten file dikembalikan. Lihat Menentukan header rentang untuk operasi Azure Files untuk informasi selengkapnya. |
x-ms-range-get-content-md5: true |
Pilihan. Ketika header ini diatur ke true dan ditentukan bersama dengan Range header , layanan mengembalikan hash MD5 untuk rentang, selama rentangnya berukuran kurang dari atau sama dengan 4 mebibyte (MiB).Jika header ini ditentukan tanpa Range header , layanan mengembalikan kode status 400 (Permintaan Buruk).Jika header ini diatur ke true ketika rentang melebihi ukuran 4 MiB, layanan mengembalikan kode status 400 (Permintaan Buruk). |
x-ms-lease-id:<ID> |
Pilihan. Versi 2019-02-02 dan yang lebih baru. Jika header ditentukan, operasi dilakukan hanya jika sewa file saat ini aktif dan ID sewa yang ditentukan dalam permintaan cocok dengan ID sewa file. Jika tidak, operasi gagal dengan kode status 412 (Prasyarat Gagal). |
x-ms-client-request-id |
Pilihan. Menyediakan nilai buram yang dihasilkan klien dengan batas karakter 1 kibibyte (KiB) yang dicatat dalam log saat pengelogan dikonfigurasi. Kami sangat menyarankan Anda menggunakan header ini untuk menghubungkan aktivitas sisi klien dengan permintaan yang diterima server. Untuk informasi selengkapnya, lihat Memantau Azure Files. |
x-ms-file-request-intent |
Diperlukan jika Authorization header menentukan token OAuth. Nilai yang dapat diterima adalah backup. Header ini menentukan bahwa Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action atau Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action harus diberikan jika disertakan dalam kebijakan RBAC yang ditetapkan ke identitas yang diotorisasi menggunakan Authorization header . Tersedia untuk versi 2022-11-02 dan yang lebih baru. |
x-ms-allow-trailing-dot: { <Boolean> } |
Pilihan. Versi 2022-11-02 dan yang lebih baru. Nilai Boolean menentukan apakah titik berikutnya yang ada dalam url permintaan harus dipangkas atau tidak. Untuk informasi selengkapnya, lihat Memberi nama dan mereferensikan berbagi, direktori, file, dan metadata. |
Isi permintaan
Tidak ada.
Respons
Respons mencakup kode status HTTP, sekumpulan header respons, dan isi respons, yang berisi konten file.
Kode status
Operasi yang berhasil mengembalikan kode status 200 (OK).
Untuk informasi tentang kode status, lihat Status dan Kode Kesalahan.
Header respons
Respons untuk operasi ini mencakup header berikut. Respons mungkin juga menyertakan header HTTP standar tambahan. Semua header standar sesuai dengan spesifikasi protokol HTTP/1.1.
| Header respons | Deskripsi |
|---|---|
Last-Modified |
Mengembalikan tanggal dan waktu saat file terakhir diubah. Format tanggal mengikuti RFC 1123. Untuk informasi selengkapnya, lihat Mewakili nilai tanggal/waktu di header. Setiap operasi yang memodifikasi file atau propertinya memperbarui waktu modifikasi terakhir. |
x-ms-meta-name:value |
Sekumpulan pasangan nama-nilai yang terkait dengan file ini sebagai metadata yang ditentukan pengguna. |
Content-Length |
Jumlah byte yang ada dalam isi respons. |
Content-Type |
Tipe isi yang ditentukan untuk file tersebut. Jenis konten default adalah application/octet-stream. |
Content-Range |
Rentang byte dikembalikan jika klien meminta subset file dengan mengatur Range header permintaan. |
ETag |
Berisi nilai yang dapat Anda gunakan untuk melakukan operasi secara kondisional. Nilai diapit dalam tanda kutip. |
Content-MD5 |
Jika file memiliki hash MD5 dan permintaannya adalah membaca file lengkap, header respons ini dikembalikan sehingga klien dapat memeriksa integritas konten pesan. Jika permintaan adalah membaca rentang yang ditentukan dan x-ms-range-get-content-md5 diatur ke true, permintaan mengembalikan hash MD5 untuk rentang tersebut, selama ukuran rentang kurang dari atau sama dengan 4 MiB.Jika tidak satu pun dari kumpulan kondisi ini adalah true, tidak ada nilai yang dikembalikan untuk Content-MD5 header .Jika x-ms-range-get-content-md5 ditentukan tanpa header rentang, layanan mengembalikan kode status 400 (Permintaan Buruk).Jika x-ms-range-get-content-md5 diatur ke true ketika rentang melebihi 4 MiB, layanan mengembalikan kode status 400 (Permintaan Buruk). |
Content-Encoding |
Mengembalikan nilai yang ditentukan untuk Content-Encoding header permintaan. |
Content-Language |
Mengembalikan nilai yang ditentukan untuk Content-Language header permintaan. |
Cache-Control |
Dikembalikan jika sebelumnya ditentukan untuk file. |
Content-Disposition |
Mengembalikan nilai yang ditentukan untuk x-ms-content-disposition header dan menentukan cara memproses respons.Bidang Content-Disposition header respons menyampaikan informasi tambahan tentang cara memproses payload respons, dan juga dapat digunakan untuk melampirkan metadata tambahan. Misalnya, jika diatur ke attachment, Content-Disposition menunjukkan bahwa agen pengguna tidak boleh menampilkan respons tetapi, sebagai gantinya, harus menampilkan jendela Simpan Sebagai. |
x-ms-request-id |
Secara unik mengidentifikasi permintaan yang dibuat dan dapat digunakan untuk memecahkan masalah permintaan. Untuk informasi selengkapnya, lihat Memecahkan masalah operasi API. |
x-ms-version |
Versi layanan yang digunakan untuk menjalankan permintaan. |
Accept-Ranges: bytes |
Menunjukkan bahwa layanan mendukung permintaan untuk konten file parsial. |
Date |
Date |
x-ms-copy-completion-time:<datetime> |
Versi 2015-02-21 dan yang lebih baru. Waktu kesimpulan dari operasi Salin File yang terakhir dicoba di mana file ini adalah file tujuan. Nilai ini dapat menentukan waktu upaya penyalinan yang selesai, dibatalkan, atau gagal. Header ini tidak muncul jika salinan tertunda, jika file ini belum pernah menjadi tujuan dalam operasi Salin File , atau jika file ini telah dimodifikasi setelah operasi Salin File yang disimpulkan yang menggunakan Atur Properti File atau Buat File. |
x-ms-copy-status-description: <error string> |
Versi 2015-02-21 dan yang lebih baru. Muncul hanya ketika x-ms-copy-statusgagal atautertunda. Menjelaskan penyebab kegagalan operasi penyalinan yang fatal atau tidak fatal. Header ini tidak muncul jika file ini belum pernah menjadi tujuan dalam operasi Salin File , atau jika file ini telah dimodifikasi setelah operasi Salin File yang disimpulkan yang menggunakan SetEl Properti File atau Buat File. |
x-ms-copy-id: <id> |
Versi 2015-02-21 dan yang lebih baru. Pengidentifikasi string untuk operasi Salin File yang terakhir dicoba di mana file ini adalah file tujuan. Header ini tidak muncul jika file belum pernah menjadi tujuan dalam operasi Salin File , atau jika file ini telah dimodifikasi setelah operasi Salin File yang disimpulkan yang menggunakan Atur Properti File atau Buat File. |
x-ms-copy-progress: <bytes copied/bytes total> |
Versi 2015-02-21 dan yang lebih baru. Berisi jumlah byte yang disalin dan total byte dalam sumber dalam operasi Salin File terakhir yang dicoba di mana file ini adalah file tujuan. Dapat menampilkan dari 0 hingga jumlah byte yang disalin Content-Length . Header ini tidak muncul jika file ini belum pernah menjadi tujuan dalam operasi Salin File , atau jika file ini telah dimodifikasi setelah operasi Salin File yang disimpulkan yang menggunakan SetEl Properti File atau Buat File. |
x-ms-copy-source: url |
Versi 2015-02-21 dan yang lebih baru. URL dengan panjang hingga 2 KB yang menentukan file sumber yang digunakan dalam operasi Salin File yang terakhir dicoba di mana file ini adalah file tujuan. Header ini tidak muncul jika file ini belum pernah menjadi tujuan dalam operasi Salin File atau jika file ini telah dimodifikasi setelah operasi Salin File yang disimpulkan yang menggunakan Set File Properties atau Create File. |
x-ms-copy-status: <pending ¦ success ¦ aborted ¦ failed> |
Versi 2015-02-21 dan yang lebih baru. Status operasi salin yang diidentifikasi oleh x-ms-copy-id, dengan nilai-nilai ini:- pending: Salinan sedang berlangsung. Periksa apakah x-ms-copy-status-description kesalahan terputus-terputus dan tidak fatal menghambat kemajuan penyalinan tetapi tidak menyebabkan kegagalan.- success: Penyalinan berhasil diselesaikan.- aborted: Penyalinan diakhbungi oleh Batalkan Salin File.- failed: Penyalinan gagal. Lihat x-ms-copy-status-description untuk detail kegagalan.Header ini tidak muncul jika file ini belum pernah menjadi tujuan dalam operasi Salin File , atau jika file ini telah dimodifikasi setelah operasi Salin File selesai yang menggunakan SetEl Properti File atau Buat File. |
x-ms-content-md5 |
Pada versi 2016-05-31, jika file memiliki hash MD5, dan jika permintaan berisi header rentang (range atau x-ms-range), header respons ini dikembalikan dengan nilai seluruh nilai MD5 file. Nilai ini mungkin atau mungkin tidak sama dengan nilai yang dikembalikan di Content-MD5 header , yang dihitung dari rentang yang diminta. |
x-ms-server-encrypted: true/false |
Versi 2017-04-17 dan yang lebih baru. Nilai header ini diatur ke true jika data file dan metadata aplikasi sepenuhnya dienkripsi dengan menggunakan algoritma yang ditentukan. Jika file tidak terenkripsi, atau jika hanya bagian dari metadata file/aplikasi yang dienkripsi, nilai diatur ke false. |
x-ms-file-permission-key |
Kunci izin file. |
x-ms-file-attributes |
Atribut sistem file pada file. Untuk informasi selengkapnya, lihat daftar atribut yang tersedia. |
x-ms-file-creation-time |
Nilai tanggal/waktu UTC yang mewakili properti waktu pembuatan untuk file. |
x-ms-file-last-write-time |
Nilai tanggal/waktu UTC yang mewakili properti waktu tulis terakhir untuk file. |
x-ms-file-change-time |
Tanggal/waktu UTC yang mewakili properti waktu perubahan untuk file. |
x-ms-file-file-id |
ID file file. |
x-ms-file-parent-id |
ID file induk file. |
x-ms-lease-duration:infinite |
Versi 2019-02-02 dan yang lebih baru. Ketika file disewakan, menentukan bahwa sewa memiliki durasi tak terbatas. |
x-ms-lease-state: <available, leased, broken> |
Versi 2019-02-02 dan yang lebih baru. Ketika file disewa, menentukan status sewa file. |
x-ms-lease-status: <locked, unlocked> |
Versi 2019-02-02 dan yang lebih baru. Ketika file disewa, menentukan status sewa file. |
x-ms-client-request-id |
Dapat digunakan untuk memecahkan masalah permintaan dan respons yang sesuai. Nilai header ini sama dengan nilai x-ms-client-request-id header jika ada dalam permintaan dan nilainya berisi tidak lebih dari 1.024 karakter ASCII yang terlihat. x-ms-client-request-id Jika header tidak ada dalam permintaan, header tidak ada dalam respons. |
Isi Respons
Isi respons berisi konten file.
Respons sampel
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
Authorization
Hanya pemilik akun yang dapat memanggil operasi ini.
Keterangan
Memanggil Get File rentang yang belum memiliki konten atau yang telah dihapus pengembalian 0 untuk byte tersebut.
Jika Anda memanggil Get File tanpa rentang yang ditentukan, layanan mengembalikan rentang byte hingga nilai yang ditentukan untuk x-ms-content-length header . Untuk rentang apa pun yang tidak memiliki konten, layanan akan kembali 0 untuk byte tersebut.
Operasi Get File diperbolehkan dua menit per MiB selesai. Operasi yang memakan waktu lebih dari dua menit per MiB rata-rata akan kehabisan waktu.