Daftar Direktori dan File

Artikel
03/29/2023

Operasi List Directories and Files mengembalikan daftar file atau direktori di bawah berbagi atau direktori yang ditentukan. Ini mencantumkan konten hanya untuk satu tingkat hierarki direktori.

Ketersediaan protokol

Mengaktifkan protokol berbagi file	Tersedia
SMB
NFS

Minta

Anda dapat membuat List Directories and Files permintaan sebagai berikut. HTTPS disarankan.

Metode	Meminta URI	Versi HTTP
`GET`	`https://myaccount.file.core.windows.net/myshare/mydirectorypath?restype=directory&comp=list`	HTTP/1.1
`GET`	`https://myaccount.file.core.windows.net/myshare/mydirectorypath?restype=directory&sharesnapshot=<DateTime>&comp=list`	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`	Jalur ke 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
`prefix`	Opsional. Versi 2016-05-31 dan yang lebih baru. Memfilter hasil untuk mengembalikan hanya file dan direktori yang memiliki nama yang dimulai dengan awalan yang ditentukan.
`sharesnapshot`	Pilihan. Versi 2017-04-17 dan yang lebih baru. Parameter salinan bayangan berbagi adalah nilai buram `DateTime` yang, saat ada, menentukan salinan bayangan berbagi untuk dikueri untuk daftar file dan direktori.
`marker`	Pilihan. Nilai string yang mengidentifikasi bagian daftar yang akan dikembalikan dengan operasi daftar 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`	Pilihan. Menentukan jumlah maksimum file atau direktori yang akan dikembalikan. Jika permintaan tidak menentukan `maxresults`, atau menentukan nilai yang lebih besar dari 5.000, server akan mengembalikan hingga 5.000 item. Pengaturan `maxresults` ke nilai yang kurang dari atau sama dengan nol menghasilkan kode respons kesalahan 400 (Permintaan Buruk).
`include={Timestamps, ETag, Attributes, PermissionKey}`	Tersedia secara opsional, mulai versi 2020-04-08. Menentukan satu atau beberapa properti untuk disertakan dalam respons: `Timestamps` `ETag` `Attributes` (Atribut file Win32) `PermissionKey` Untuk menentukan lebih dari salah satu opsi ini pada URI, Anda harus memisahkan setiap opsi dengan koma yang dikodekan URL (`%82`). Header `x-ms-file-extended-info` secara implisit diasumsikan benar ketika parameter ini ditentukan.
`timeout`	Pilihan. Parameter `timeout` dinyatakan dalam hitung detik. Untuk informasi selengkapnya, lihat Mengatur batas waktu untuk operasi Azure Files.

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-file-extended-info: {true}`	Pilihan. Versi 2020-04-08 dan yang lebih baru. Header ini secara implisit diasumsikan benar jika `include` parameter kueri tidak kosong. Jika true, `Content-Length` properti akan diperbarui. Dalam versi 2020-04-08, 2020-06-12, dan 2020-08-04, `FileId` dikembalikan untuk file dan direktori hanya jika header ini benar. Dalam versi 2020-10-02 dan yang lebih baru, `FileId` selalu dikembalikan untuk file dan direktori.
`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
`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` 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

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 ServiceEndpoint="https://myaccount.file.core.windows.net/" ShareName="myshare" ShareSnapshot="date-time" DirectoryPath="directory-path">  
  <Marker>string-value</Marker>
  <Prefix>string-value</Prefix>
  <MaxResults>int-value</MaxResults>
  <DirectoryId>directory-id</DirectoryId>
  <Entries>
    <File>
      <FileId>file-id</FileId>
      <Name>file-name</Name>  
      <Properties>  
        <Content-Length>size-in-bytes</Content-Length>
        <CreationTime>datetime</CreationTime>
        <LastAccessTime>datetime</LastAccessTime>
        <LastWriteTime>datetime</LastWriteTime>
        <ChangeTime>datetime</ChangeTime>
        <Last-Modified>datetime</Last-Modified>
        <Etag>etag</Etag>
      </Properties>
      <Attributes>Archive | Hidden | Offline | ReadOnly</Attributes>
      <PermissionKey>4066528134148476695*1</PermissionKey>
    </File>  
    <Directory>
      <FileId>file-id</FileId>
      <Name>directory-name</Name>  
      <Properties>
        <CreationTime>datetime</CreationTime>
        <LastAccessTime>datetime</LastAccessTime>
        <LastWriteTime>datetime</LastWriteTime>
        <ChangeTime>datetime</ChangeTime>
        <Last-Modified>datetime</Last-Modified>
        <Etag>etag</Etag>
      </Properties>
      <Attributes>Archive | Hidden | Offline | ReadOnly</Attributes>
      <PermissionKey>4066528134148476695*1</PermissionKey>
    </Directory>  
  </Entries>  
  <NextMarker />  
</EnumerationResults>

Perhatikan bahwa Content-Length elemen dikembalikan dalam daftar. Namun, nilai ini mungkin tidak diperbarui, karena klien SMB mungkin telah memodifikasi file secara lokal. Nilai Content-Length mungkin tidak mencerminkan fakta itu sampai handel ditutup, atau op-lock rusak. Untuk mengambil nilai properti saat ini, gunakan x-ms-file-extended-info: true, atau panggil Dapatkan Properti File.

Dalam versi 2020-04-08, 2020-06-12, dan 2020-08-04, FileId dikembalikan untuk file dan direktori jika header x-ms-file-extended-info benar. Dalam versi 2020-10-02 dan yang lebih baru, FileId selalu dikembalikan untuk file dan direktori.

Dalam versi 2020-04-08, include={timestamps} mengembalikan properti tanda waktu berikut: CreationTime, , LastAccessTimedan LastWriteTime. Dalam versi dan yang 2020-06-12 lebih baru, include={timestamps} mengembalikan properti tanda waktu berikut: CreationTime, , LastAccessTime, LastWriteTimeChangeTime, dan Last-Modified.

Dalam versi 2020-10-02 dan yang lebih baru, DirectoryId dikembalikan dalam respons. Ini menentukan FileId direktori tempat API dipanggil.

Dalam versi 2021-12-02 dan yang lebih baru, List Directory and Files akan mengodekan persen (per RFC 2396) semua FileName, , PrefixDirectoryNameatau DirectoryPath nilai elemen yang berisi karakter yang tidak valid di XML (khususnya, U+FFFE atau U+FFFF). Jika dikodekan, Nameelemen , Prefix atau EnumerationResults akan menyertakan Encoded=true atribut . Perhatikan bahwa ini hanya akan terjadi untuk Name nilai elemen yang berisi karakter yang tidak valid di XML, bukan elemen yang tersisa Name dalam respons.

Format tanggalwaktu dan versi API untuk bidang tanda waktu

Elemen	Format tanggalwaktu	Sampel nilai	versi API
`CreationTime`	ISO 8601	`2020-09-17T13:38:03.2740000Z`	2020-04-08 dan yang lebih baru
`LastAccessTime`	ISO 8601	`2020-09-17T13:38:03.2740000Z`	2020-04-08 dan yang lebih baru
`LastWriteTime`	ISO 8601	`2020-09-17T13:38:03.2740000Z`	2020-04-08 dan yang lebih baru
`ChangeTime`	ISO 8601	`2020-09-17T13:38:03.2740000Z`	2020-06-12 dan yang lebih baru
`Last-Modified`	RFC 1123	`Thu, 17 Sep 2020 13:38:07 GMT`	2020-06-12 dan yang lebih baru

Authorization

Hanya pemilik akun yang dapat memanggil operasi ini.

Keterangan

Nilai yang Content-Length dikembalikan dalam elemen sesuai dengan nilai header file x-ms-content-length .

Perhatikan bahwa setiap Directory elemen yang dikembalikan dihitung terhadap hasil maksimum, sama seperti setiap File elemen. File dan direktori dicantumkan terinterming, dalam urutan yang diurutkan secara leksikal dalam isi respons.

Daftar terbatas pada satu tingkat hierarki direktori. Untuk mencantumkan beberapa tingkat, Anda dapat melakukan beberapa panggilan dengan cara berulang. Gunakan nilai yang Directory dikembalikan dari satu hasil dalam panggilan berikutnya ke List Directories and Files.

Lihat juga

Operasi pada direktori