Bagikan melalui

Daftar Direktori dan File

  • Artikel

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. Operasi ini didukung dalam versi 2025-05-05 dan yang lebih baru untuk Berbagi File dengan protokol NFS diaktifkan.

Ketersediaan protokol

Protokol berbagi file yang diaktifkan Tersedia
SMB Ya
NFS Ya

Minta

Permintaan List Directories and Files dibangun sebagai berikut. Kami menyarankan agar Anda menggunakan HTTPS.

Metode Meminta URI Versi HTTP
DAPAT https://myaccount.file.core.windows.net/myshare/mydirectorypath?restype=directory&comp=list HTTP/1.1
DAPAT https://myaccount.file.core.windows.net/myshare/mydirectorypath?restype=directory&sharesnapshot=<DateTime>&comp=list 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 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 URI umum

Parameter Deskripsi
prefix Fakultatif. 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 Fakultatif. Versi 2017-04-17 dan yang lebih baru. Parameter rekam jepret berbagi adalah nilai DateTime buram yang, saat ada, menentukan salinan bayangan berbagi untuk dikueri untuk daftar file dan direktori.
marker Fakultatif. 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 Fakultatif. Menentukan jumlah maksimum file atau direktori yang akan dikembalikan. Jika permintaan tidak menentukan maxresults, atau menentukan nilai yang lebih besar dari 5.000, server mengembalikan hingga 5.000 item.

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.

Parameter URI SMB saja

Parameter Deskripsi
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.

Parameter URI NFS saja

Tidak.

Header permintaan

Header permintaan yang diperlukan dan opsional dijelaskan dalam tabel berikut:

Header permintaan umum

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 yang diotorisasi. Menentukan versi operasi yang akan digunakan untuk permintaan ini. Operasi ini didukung dalam versi 2025-05-05 dan yang lebih baru untuk Berbagi File dengan protokol NFS diaktifkan.

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-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.

Header ini diabaikan jika target terletak di Berbagi File dengan protokol NFS diaktifkan, yang mendukung titik berikutnya secara default.

Untuk informasi selengkapnya, lihat Penamaan dan referensi berbagi, direktori, file, dan metadata.

Header permintaan hanya SMB

Header permintaan Deskripsi
x-ms-file-extended-info: {true} Fakultatif. Versi 2020-04-08 dan yang lebih baru. Header ini secara implisit diasumsikan benar jika parameter kueri include tidak kosong. Jika true, properti Content-Length untuk file yang menunjukkan ukuran file akan diperbarui.

Header permintaan NFS saja

Tidak.

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 mencakup header dalam tabel berikut. Respons juga dapat menyertakan header HTTP standar tambahan. Semua header standar sesuai dengan spesifikasi protokol HTTP/1.1 .

Header respons umum

Header respons Deskripsi
Content-Type Menentukan format di mana hasil dikembalikan. Saat ini nilai ini 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 operasi API Pemecahan Masalah .
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 header x-ms-client-request-id, jika ada dalam permintaan. Nilainya paling banyak 1024 karakter ASCII yang terlihat. Jika header x-ms-client-request-id tidak ada dalam permintaan, header ini tidak akan ada dalam respons.

Header respons SMB saja

Tidak.

Header respons NFS saja

Tidak.

Isi respons

Format respons XML adalah sebagai berikut.

Elemen Marker, ShareSnapshot, dan MaxResults hanya ada jika Anda menentukannya pada URI permintaan. Elemen NextMarker memiliki nilai hanya jika hasil daftar tidak selesai.

Elemen Content-Length dikembalikan dalam daftar untuk file, yang menunjukkan ukuran file. Namun, nilai ini mungkin tidak up-to-date, karena klien SMB atau NFS mungkin telah memodifikasi file secara lokal. Nilai Content-Length mungkin tidak mencerminkan fakta itu sampai handel ditutup, atau kunci operasi SMB rusak. Untuk mengambil nilai properti saat ini, gunakan x-ms-file-extended-info: true untuk direktori yang terletak di Berbagi File dengan protokol SMB diaktifkan, atau panggil Dapatkan Properti File terhadap file tertentu.

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

Isi respons untuk Berbagi File dengan protokol SMB diaktifkan

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

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, LastAccessTime, dan LastWriteTime. Dalam versi 2020-06-12 dan yang lebih baru, include={timestamps} mengembalikan properti tanda waktu berikut: CreationTime, LastAccessTime, LastWriteTime, ChangeTime, dan Last-Modified.

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

Isi respons untuk Berbagi File dengan protokol NFS diaktifkan

<?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>
      </Properties>
    </File>
    <Directory>
      <FileId>file-id</FileId>
      <Name>directory-name</Name>
    </Directory>
  </Entries>
  <NextMarker />
</EnumerationResults>

Format tanggalwaktu dan versi API untuk bidang tanda waktu

Elemen Format tanggalwaktu Nilai sampel 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

Otorisasi

Hanya pemilik akun yang dapat memanggil operasi ini.

Komentar

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

Setiap elemen Directory yang dikembalikan dihitung ke hasil maksimum, seperti yang dilakukan setiap elemen File. File dan direktori dicantumkan secara 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 Directory yang dikembalikan dari satu hasil dalam panggilan berikutnya ke List Directories and Files.

Lihat juga

Operasi pada Direktori