Dapatkan Properti File

Operasi mengembalikan Get File Properties semua metadata yang ditentukan pengguna, properti HTTP standar, dan properti sistem untuk file. Ini tidak mengembalikan konten file.

Ketersediaan protokol

Mengaktifkan protokol berbagi file Tersedia
SMB Ya
NFS Tidak

Minta

Permintaan Get File Properties dapat dibuat sebagai berikut. Kami menyarankan agar Anda menggunakan HTTPS.

Metode Meminta URI Versi HTTP
HEAD https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile HTTP/1.1
HEAD https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?sharesnapshot=<DateTime> 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 Opsional. Jalur ke direktori induk.
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
sharesnapshot Opsional. Versi 2017-04-17 dan yang lebih baru. Parameter sharesnapshot adalah nilai DateTime buram yang, saat ada, menentukan salinan bayangan berbagi untuk mengkueri properti file.
timeout Pilihan. 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.
x-ms-lease-id:<ID> Opsional. 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 cocok, 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 analitik saat pengelogan Azure Storage Analytics diaktifkan. Kami sangat menyarankan Anda menggunakan header ini saat Anda menghubungkan aktivitas sisi klien dengan permintaan yang diterima oleh server. Untuk informasi selengkapnya, lihat Memantau Azure Blob Storage.
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 dan sekumpulan header respons.

Kode status

Operasi yang berhasil mengembalikan kode status 200 (OK).

Untuk informasi selengkapnya tentang kode status, lihat Status dan kode kesalahan.

Header respons

Respons untuk operasi ini mencakup header berikut. Respons juga dapat mencakup 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.
x-ms-type: <File> Mengembalikan jenis File. Disiapkan untuk penggunaan masa mendatang.
Content-Length Ukuran file dalam byte. Header ini mengembalikan nilai x-ms-content-length header yang disimpan dengan file .
Content-Type Tipe konten yang ditentukan untuk file. Jika tidak ada tipe konten yang ditentukan, jenis konten default adalah application/octet-stream.
ETag ETag berisi nilai yang dapat Anda gunakan untuk melakukan operasi secara kondisional. Nilai diapit dalam tanda kutip.
Content-MD5 Content-MD5 Jika header telah diatur untuk file, Content-MD5 header respons dikembalikan sehingga klien dapat memeriksa integritas konten pesan.
Content-Encoding Content-Encoding Jika header permintaan sebelumnya telah diatur untuk file, Content-Encoding nilai dikembalikan di header ini.
Content-Language Content-Language Jika header permintaan sebelumnya telah diatur untuk file, Content-Language nilai dikembalikan di header ini.
Cache-Control Cache-Control Jika header permintaan sebelumnya telah diatur untuk file, Cache-Control nilai dikembalikan di header ini.
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 Anda dapat menggunakannya untuk melampirkan metadata tambahan. Misalnya, jika diatur ke attachment, Content-Disposition menunjukkan bahwa agen pengguna tidak boleh menampilkan respons, tetapi harus menampilkan jendela Simpan Sebagai sebagai gantinya.
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 Menunjukkan versi layanan yang digunakan untuk menjalankan permintaan.
Date Nilai tanggal/waktu UTC yang dihasilkan oleh layanan, yang menunjukkan waktu ketika respons dimulai.
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 dengan 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. Ini menjelaskan penyebab kegagalan operasi salinan fatal atau tidak fatal. 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 dengan menggunakan Atur 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 ini belum pernah menjadi tujuan dalam operasi Salin File , atau jika file ini telah dimodifikasi setelah operasi Salin File yang disimpulkan dengan 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 memperlihatkan antara 0 dan jumlah Content-Length byte yang disalin. 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 dengan menggunakan Atur Properti File atau Buat File.
x-ms-copy-source: url Versi 2015-02-21 dan yang lebih baru. URL hingga 2 KB karakter yang menentukan file sumber yang digunakan dalam operasi Salin File terakhir yang 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 dengan menggunakan Atur Properti File atau Buat 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:

- Sukses: Penyalinan berhasil diselesaikan.
- Tertunda: Penyalinan sedang berlangsung. Periksa apakah x-ms-copy-status-description kesalahan terputus-terputus dan tidak fatal menghambat kemajuan penyalinan tetapi tidak menyebabkan kegagalan.
- Dibatalkan: Penyalinan diakhir oleh Batalkan Salin File.
- Gagal: 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 yang disimpulkan dengan menggunakan Atur Properti File atau Buat File.
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. Nilai diatur ke false jika file tidak terenkripsi, atau jika hanya bagian dari file atau metadata aplikasi yang dienkripsi.
x-ms-file-permission-key Versi 2019-02-02 dan yang lebih baru. Kunci izin file.
x-ms-file-attributes Versi 2019-02-02 dan yang lebih baru. Atribut sistem file file. Untuk informasi selengkapnya, lihat daftar atribut yang tersedia.
x-ms-file-creation-time Versi 2019-02-02 dan yang lebih baru. Nilai tanggal/waktu UTC yang mewakili properti waktu pembuatan untuk file.
x-ms-file-last-write-time Versi 2019-02-02 dan yang lebih baru. Nilai tanggal/waktu UTC yang mewakili properti waktu tulis terakhir untuk file.
x-ms-file-change-time Versi 2019-02-02 dan yang lebih baru. Nilai tanggal/waktu UTC yang mewakili properti waktu perubahan untuk file.
x-ms-file-file-id Versi 2019-02-02 dan yang lebih baru. ID file file.
x-ms-file-parent-id Versi 2019-02-02 dan yang lebih baru. 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 nilai 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

Tidak ada.

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.

Lihat juga

Operasi pada Azure Files