Rentang Daftar
Operasi List Ranges
mengembalikan daftar rentang yang valid untuk file.
Ketersediaan protokol
Mengaktifkan protokol berbagi file | Tersedia |
---|---|
SMB | |
NFS |
Minta
Anda dapat membuat List Ranges
permintaan sebagai berikut. HTTPS disarankan.
Metode | Meminta URI | Versi HTTP |
---|---|---|
GET | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=rangelist |
HTTP/1.1 |
GET | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?sharesnapshot=<DateTime>&comp=rangelist |
HTTP/1.1 |
GET | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=rangelist&snapshot=<DateTime>&prevsharesnapshot=<DateTime> |
HTTP/1.1 |
GET | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=rangelist&prevsharesnapshot=<DateTime> |
HTTP/1.1 |
Ganti komponen jalur yang ditunjukkan 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 induk. |
myfile |
Nama file. |
Untuk detail tentang pembatasan penamaan jalur, lihat Penamaan dan referensi berbagi, direktori, file, dan metadata.
Parameter URI
Anda dapat menentukan parameter tambahan berikut pada URI permintaan.
Parameter | Deskripsi |
---|---|
sharesnapshot |
Opsional. Versi 2017-04-17 dan yang lebih baru. Parameter sharesnapshot adalah nilai buram DateTime yang, saat ada, menentukan salinan bayangan berbagi untuk dikueri untuk file. |
timeout |
Pilihan. Parameter timeout dinyatakan dalam hitung detik. Untuk informasi selengkapnya, lihat Mengatur batas waktu untuk operasi Azure Files. |
prevsharesnapshot |
Opsional dalam versi 2020-02-10 dan yang lebih baru. Parameter prevsharesnapshot adalah nilai buram DateTime yang, saat ada, menentukan rekam jepret sebelumnya.Ketika parameter ini dan sharesnapshot ada, respons hanya akan berisi rentang halaman yang diubah di antara dua rekam jepret. Ketika hanya prevsharesnapshot ada, respons hanya akan berisi rentang halaman yang diubah antara rekam jepret ini dan berbagi langsung.Halaman yang diubah mencakup halaman yang diperbarui dan dihapus. |
Header permintaan
Tabel berikut ini menjelaskan header permintaan yang diperlukan dan opsional.
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. Menentukan rentang byte untuk mencantumkan rentang, secara inklusif. Jika dihilangkan, maka semua rentang untuk file dikembalikan. |
x-ms-range |
Pilihan. Menentukan rentang byte untuk mencantumkan rentang, secara inklusif. Jika header Range dan x-ms-range ditentukan, layanan menggunakan nilai x-ms-range . Lihat Menentukan header rentang untuk operasi Azure Files untuk informasi selengkapnya. |
x-ms-lease-id:<ID> |
Pilihan. Versi 2019-02-02 dan yang lebih baru. Jika header ditentukan, operasi akan dilakukan hanya jika sewa file saat ini aktif, dan ID sewa yang ditentukan dalam permintaan cocok dengan 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 di url permintaan harus dipangkas atau tidak. Untuk informasi selengkapnya, lihat Penamaan dan referensi berbagi, direktori, file, dan metadata. |
Isi permintaan
Tidak ada.
Respons
Respons mencakup kode status HTTP, sekumpulan header respons, dan isi respons dalam format XML.
Kode status
Operasi yang berhasil mengembalikan kode status 200 (OK). Untuk informasi tentang kode status, lihat Kode status dan 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 |
Tanggal/waktu file terakhir diubah. Operasi apa pun yang memodifikasi file, termasuk pembaruan metadata atau properti file, mengubah waktu modifikasi terakhir file. |
ETag |
ETag berisi nilai yang mewakili versi file, dalam tanda kutip. |
x-ms-content-length |
Ukuran file dalam byte. Ketika prevsharesnapshot ada, maka nilai menjelaskan ukuran file di sharesnapshot (jika sharesnapshot parameter kueri ada). Jika tidak, ini menjelaskan ukuran file langsung. |
x-ms-request-id |
Header ini secara unik mengidentifikasi permintaan yang dibuat, dan dapat digunakan untuk memecahkan masalah permintaan. Untuk informasi selengkapnya, lihat Pemecahan masalah operasi API. |
x-ms-version |
Menunjukkan versi Azure Files yang digunakan untuk menjalankan permintaan. |
Date atau x-ms-date |
Nilai tanggal/waktu UTC yang menunjukkan waktu di mana respons dimulai. Layanan menghasilkan nilai ini. |
x-ms-client-request-id |
Anda dapat menggunakan header ini untuk memecahkan masalah permintaan dan respons terkait. Nilai header ini sama dengan nilai x-ms-client-request-id header, jika ada dalam permintaan. Nilainya paling banyak 1024 karakter ASCII yang terlihat.
x-ms-client-request-id Jika header tidak ada dalam permintaan, header ini tidak akan ada dalam respons. |
Isi Respons
Isi respons menyertakan daftar rentang valid yang tidak tumpang tindih, diurutkan dengan meningkatkan rentang alamat. Format isi respons adalah sebagai berikut.
<?xml version="1.0" encoding="utf-8"?>
<Ranges>
<Range>
<Start>Start Byte</Start>
<End>End Byte</End>
</Range>
<Range>
<Start>Start Byte</Start>
<End>End Byte</End>
</Range>
</Ranges>
Jika seluruh rangkaian rentang file telah dibersihkan, isi respons tidak akan menyertakan rentang apa pun.
Jika prevsharesnapshot
ditentukan, respons hanya menyertakan halaman yang berbeda antara rekam jepret target (atau file langsung) dan rekam jepret sebelumnya. Rentang yang dikembalikan mencakup kedua rentang yang diperbarui atau yang dibersihkan. Format respons ini adalah sebagai berikut:
<?xml version="1.0" encoding="utf-8"?>
<Ranges>
<Range>
<Start>Start Byte</Start>
<End>End Byte</Start>
</Range>
<ClearRange>
<Start>Start Byte</Start>
<End>End Byte</Start>
</ClearRange>
<Range>
<Start>Start Byte</Start>
<End>End Byte</Start>
</Range>
</Ranges>
Jika seluruh kumpulan halaman file telah dibersihkan, dan prevsharesnapshot
parameter tidak ditentukan, isi respons tidak akan menyertakan rentang apa pun.
Authorization
Hanya pemilik akun yang dapat memanggil operasi ini.
Keterangan
Offset byte awal dan akhir untuk setiap rentang bersifat inklusif. Lihat contoh Operasi Pembaruan Rentang dan Operasi Hapus Rentang untuk Letakkan Rentang. Contoh-contoh ini menunjukkan rentang apa yang dikembalikan jika Anda menulis atau menghapus rentang byte 512-unaligned dari file.
Dalam file yang sangat terfragmentasi dengan sejumlah besar penulisan, List Ranges
permintaan dapat gagal karena waktu server internal habis. Aplikasi yang mengambil rentang file dengan sejumlah besar operasi tulis harus mengambil subset rentang pada satu waktu.
Dimulai dengan versi 2020-02-10, Anda dapat memanggil List Ranges
dengan prevsharesnapshot
parameter . Ini mengembalikan rentang yang berbeda antara file langsung dan rekam jepret, atau di antara dua rekam jepret file pada rekam jepret. Dengan menggunakan perbedaan rentang ini, Anda dapat mengambil rekam jepret bertahap dari file. Rekam jepret inkremental adalah cara hemat biaya untuk mencadangkan file jika Anda ingin menerapkan solusi pencadangan Anda sendiri.
Operasi tertentu pada file menyebabkan List Ranges
gagal ketika dipanggil untuk mengambil rekam jepret inkremental. Layanan mengembalikan:
- 404 (Tidak Ditemukan) jika Anda memanggil pada file yang tidak ada di salah satu rekam jepret (atau aktif, jika
sharesnapshot
tidak ditentukan). - 409 (Konflik) jika Anda memanggil pada file yang merupakan target salinan timpa setelah rekam jepret, ditentukan oleh
prevsharesnapshot
. - 409 (Konflik) jika Anda memanggil pada file yang dihapus dan dibuat ulang dengan nama dan lokasi yang sama, setelah rekam jepret yang ditentukan oleh
prevsharesnapshot
diambil.