Handel Daftar

Artikel
03/29/2023

Operasi List Handles mengembalikan daftar handel terbuka pada direktori atau file. Secara opsional, ini dapat secara rekursif menghitung handel yang dibuka pada direktori dan file. API ini tersedia mulai versi 2018-11-09.

Ketersediaan protokol

Mengaktifkan protokol berbagi file	Tersedia
SMB
NFS

Minta

Anda dapat membuat List Handles permintaan sebagai berikut. HTTPS disarankan.

Metode	Meminta URI	Versi HTTP
`GET`	`https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfileordirectory?comp=listhandles`	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.
`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`	Opsional. Nilai string yang mengidentifikasi bagian daftar yang akan dikembalikan dengan operasi berikutnya `List Handles` . 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`	Pilihan. Menentukan jumlah maksimum handel yang diambil pada file atau direktori yang akan dikembalikan. Pengaturan `maxresults` ke nilai yang kurang dari atau sama dengan nol menghasilkan kode respons kesalahan 400 (Permintaan Buruk).
`timeout`	Pilihan. Parameter `timeout` dinyatakan dalam hitung detik. Untuk informasi selengkapnya, lihat Mengatur batas waktu untuk operasi Azure Files.
`sharesnapshot`	Pilihan. Parameter `sharesnapshot` adalah nilai buram `DateTime` yang, saat ada, menentukan salinan bayangan berbagi untuk dikueri untuk daftar handel.

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 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`	Opsional. 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`	Opsional. 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 `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> }`	Opsional. 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
`Content-Type`	Menentukan format di mana hasil dikembalikan. Saat ini nilai ini adalah `application/xml`.
`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`	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

Format respons XML adalah sebagai berikut. Perhatikan bahwa Markerelemen , ShareSnapshot, dan MaxResults hanya ada jika Anda menentukannya pada URI permintaan. Elemen NextMarker memiliki nilai hanya jika hasil daftar tidak selesai.

<?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>
            <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:

Bidang	Deskripsi	Tujuan
`HandleId`	ID handel layanan XSMB, UINT64.	Digunakan untuk mengidentifikasi handel.
`Path`	Nama file, termasuk jalur lengkap, dimulai dari akar berbagi. String.	Digunakan untuk mengidentifikasi nama objek tempat handel terbuka.
`ClientIp`	IP klien yang membuka handel. String.	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` secara unik mengidentifikasi file. Ini berguna selama penggantian nama, karena `FileId` tidak berubah.
`ParentId`	ID File Induk, UINT64.	`ParentId` secara unik mengidentifikasi direktori. 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 ketika 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 versi layanan 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 Path nilai elemen yang berisi karakter yang tidak valid dalam XML (khususnya, U+FFFE atau U+FFFF). Jika dikodekan, Path elemen akan menyertakan Encoded=true atribut . Perhatikan bahwa ini hanya akan terjadi untuk Path nilai elemen yang berisi karakter yang tidak valid dalam XML, bukan elemen yang tersisa Path dalam respons.

Authorization

Hanya pemilik akun yang dapat memanggil operasi ini.

Keterangan

HandleId adalah ID handel sisi layanan, berbeda dari ID handel klien. Pemetaan antara keduanya dimungkinkan di klien.