Handel Daftar
Operasi List Handles
mengembalikan daftar handel terbuka pada direktori atau file. Secara opsional, ini dapat menghitung handel yang terbuka secara rekursif pada direktori dan file. API ini tersedia mulai versi 2018-11-09.
Ketersediaan protokol
Protokol berbagi file yang diaktifkan | Tersedia |
---|---|
SMB |
![]() |
NFS |
![]() |
Minta
Permintaan List Handles
dibangun sebagai berikut. Kami menyarankan agar Anda menggunakan HTTPS.
Metode | Meminta URI | Versi HTTP |
---|---|---|
DAPAT | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfileordirectory?comp=listhandles |
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 |
Fakultatif. Jalur ke direktori. |
myfileordirectory |
Nama file atau direktori. |
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.
Parameter | Deskripsi |
---|---|
marker |
Fakultatif. Nilai string yang mengidentifikasi bagian daftar yang akan dikembalikan dengan operasi List Handles berikutnya. Operasi mengembalikan nilai penanda dalam isi respons, jika daftar yang dikembalikan tidak selesai. Anda kemudian dapat menggunakan nilai penanda dalam panggilan berikutnya untuk meminta kumpulan item daftar berikutnya.Nilai penanda buram untuk klien. |
maxresults |
Fakultatif. Menentukan jumlah maksimum handel yang diambil pada file atau direktori yang akan dikembalikan. Mengatur maxresults ke nilai yang kurang dari atau sama dengan nol menghasilkan kode respons kesalahan 400 (Permintaan Buruk). |
timeout |
Fakultatif. Parameter timeout dinyatakan dalam hitung detik. Untuk informasi selengkapnya, lihat Mengatur batas waktu untuk operasi Azure Files. |
sharesnapshot |
Fakultatif. Parameter sharesnapshot adalah nilai DateTime buram yang, saat ada, menentukan salinan bayangan berbagi untuk dikueri untuk daftar handel. |
Header permintaan
Tabel berikut ini menjelaskan header permintaan yang diperlukan dan opsional.
Header permintaan | Deskripsi |
---|---|
Authorization |
Diperlukan. Menentukan skema otorisasi, nama akun, dan tanda tangan. Untuk informasi selengkapnya, lihat Mengotorisasi permintaan ke Azure Storage. |
Date atau x-ms-date |
Diperlukan. Menentukan Waktu Universal Terkoordinasi (UTC) untuk permintaan tersebut. Untuk informasi selengkapnya, lihat Mengotorisasi permintaan ke Azure Storage. |
x-ms-version |
Diperlukan untuk semua permintaan resmi, opsional untuk permintaan anonim. Menentukan versi operasi yang akan digunakan untuk permintaan ini. Untuk informasi selengkapnya, lihat Penerapan Versi untuk layanan Azure Storage. |
x-ms-client-request-id |
Fakultatif. 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-recursive |
Fakultatif. Nilai Boolean yang menentukan apakah operasi juga harus berlaku untuk file dan subdirektori direktori yang ditentukan dalam URI. |
x-ms-file-request-intent |
Diperlukan jika header Authorization menentukan token OAuth. Nilai yang dapat diterima 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 header Authorization . Tersedia untuk versi 2022-11-02 dan yang lebih baru. |
x-ms-allow-trailing-dot: { <Boolean> } |
Fakultatif. 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 Penamaan dan referensi berbagi, direktori, file, dan metadata. |
Isi permintaan
Tidak.
Jawaban
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 Status dan kode kesalahan.
Header respons
Respons untuk operasi ini menyertakan header dalam tabel berikut. Respons juga dapat mencakup header HTTP standar tambahan. Semua header standar sesuai dengan spesifikasi protokol HTTP/1.1 .
Header umum
Isi respons
Format respons XML adalah sebagai berikut. Perhatikan bahwa elemen Marker
, ShareSnapshot
, dan MaxResults
hanya ada jika Anda menentukannya pada URI permintaan. Elemen NextMarker
memiliki nilai hanya jika hasil daftar tidak selesai.
ClientName
bidang sebagai respons bersifat opsional dan dikembalikan hanya jika tersedia untuk layanan.
<?xml version="1.0" encoding="utf-8"?>
<EnumerationResults>
<HandleList>
<Handle>
<HandleId>handle-id</HandleId>
<Path>file-or-directory-name-including-full-path</Path>
<FileId>file-id</FileId>
<ParentId>parent-file-id</ParentId>
<SessionId>session-id</SessionId>
<ClientIp>client-ip</ClientIp>
<ClientName>client-name</ClientName>
<OpenTime>opened-time</OpenTime>
<LastReconnectTime>lastreconnect-time</LastReconnectTime>
<AccessRightList>
<AccessRight>Read</AccessRight>
<AccessRight>Write</AccessRight>
<AccessRight>Delete</AccessRight>
</AccessRightList>
</Handle>
...
</HandleList>
<NextMarker>next-marker</NextMarker>
</EnumerationResults>
Tabel berikut ini menjelaskan bidang isi respons:
Kebun | Deskripsi | Maksud |
---|---|---|
HandleId |
ID handel layanan XSMB, UINT64. | Digunakan untuk mengidentifikasi handel. |
Path |
Nama file, termasuk jalur lengkap, dimulai dari akar berbagi. Tali. | Digunakan untuk mengidentifikasi nama objek tempat handel terbuka. |
ClientIp |
IP klien yang membuka handel. Tali. | Digunakan untuk memutuskan apakah handel mungkin telah bocor. |
ClientName |
Bidang opsional. Didukung pada 2024-02-04 ke atas. Nama Klien (Workstation atau Nama Pengguna OS) yang membuka handel. Tali. | Digunakan untuk memutuskan apakah handel mungkin telah bocor. |
OpenTime |
Handel waktu dibuka (UTC).
DateTime sebagai String. |
Digunakan untuk memutuskan apakah handel mungkin telah bocor. Handel yang bocor biasanya telah terbuka untuk waktu yang lama. |
LastReconnectTime |
Handel waktu dibuka (UTC).
DateTime sebagai String. |
Digunakan untuk memutuskan apakah handel dibuka kembali setelah klien/server terputus, karena jaringan atau kesalahan lainnya. Bidang disertakan dalam isi respons hanya jika peristiwa pemutusan sambungan terjadi dan handel dibuka kembali. |
FileId |
ID File, UINT64. |
FileId mengidentifikasi file secara unik. Ini berguna selama penggantian nama, karena FileId tidak berubah. |
ParentId |
ID File Induk, UINT64. |
ParentId mengidentifikasi direktori secara unik. Ini berguna selama penggantian nama, karena ParentId tidak berubah. |
SessionId |
ID sesi SMB yang menentukan konteks di mana handel file dibuka. UINT64. |
SessionId disertakan dalam log penampil peristiwa saat sesi terputus secara paksa. Ini memungkinkan Anda untuk mengaitkan batch tertentu dari handel yang bocor dengan insiden jaringan tertentu. |
AccessRightList |
Izin akses yang diberikan ke handel terbuka pada file atau direktori. | Tersedia dalam layanan versi 2023-01-03 dan yang lebih baru. Digunakan untuk mengkueri izin akses yang disimpan pada file atau direktori oleh berbagai handel terbuka. Nilai yang mungkin adalah READ, WRITE, dan DELETE, atau kombinasi dari nilai-nilai ini. |
NextMarker |
String yang menjelaskan handel berikutnya yang akan dicantumkan. Ini dikembalikan ketika lebih banyak handel perlu dicantumkan untuk menyelesaikan permintaan. | String digunakan dalam permintaan berikutnya untuk mencantumkan handel yang tersisa. Tidak adanya NextMarker menunjukkan bahwa semua handel yang relevan tercantum. |
Dalam versi 2021-12-02 dan yang lebih baru, List Handles
akan mengodekan persen (per RFC 2396) semua nilai elemen Path
yang berisi karakter yang tidak valid dalam XML (khususnya, U+FFFE atau U+FFFF). Jika dikodekan, elemen Path
akan menyertakan atribut Encoded=true
. Perhatikan bahwa ini hanya akan terjadi untuk nilai elemen Path
yang berisi karakter yang tidak valid di XML, bukan elemen Path
yang tersisa dalam respons.
ClientName
didukung dalam versi 2024-02-04 dan yang lebih baru.
Otorisasi
Hanya pemilik akun yang dapat memanggil operasi ini.
Komentar
HandleId
adalah ID handel sisi layanan, berbeda dari ID handel klien. Pemetaan antara keduanya dimungkinkan di klien.