Daftar Berbagi

Artikel
08/07/2024

Operasi List Shares mengembalikan daftar berbagi dan berbagi rekam jepret di bawah akun yang ditentukan. API ini didukung sepenuhnya, tetapi merupakan API manajemen lama. Gunakan File Shares - Daftar, yang disediakan oleh penyedia sumber daya penyimpanan (Microsoft.Storage), sebagai gantinya. Untuk mempelajari selengkapnya tentang berinteraksi secara terprogram dengan sumber daya FileShare dengan menggunakan penyedia sumber daya penyimpanan, lihat Operasi di FileShares.

Ketersediaan protokol

Protokol berbagi file yang diaktifkan	Tersedia
SMB
NFS

Minta

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

Metode	Meminta URI	Versi HTTP
`GET`	`https://myaccount.file.core.windows.net/?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.

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
`prefix`	Fakultatif. Memfilter hasil untuk mengembalikan hanya berbagi yang memiliki nama yang dimulai dengan awalan yang ditentukan.
`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 berbagi yang akan dikembalikan. Jika permintaan tidak menentukan `maxresults`, atau menentukan nilai yang lebih besar dari 5.000, server akan mengembalikan hingga 5.000 item. Jika parameter diatur ke nilai yang kurang dari atau sama dengan nol, server akan mengembalikan kode status 400 (Permintaan Buruk).
`include=metadata,snapshots,deleted`	Fakultatif. Menentukan satu atau beberapa himpunan data untuk disertakan dalam respons: - `snapshots`: Versi 2017-04-17 dan yang lebih baru. Menentukan bahwa salinan bayangan berbagi harus disertakan dalam respons. Rekam jepret berbagi tercantum dari yang terlama ke terbaru dalam respons. - `metadata`: Menentukan bahwa metadata berbagi harus dikembalikan dalam respons. - `deleted`: Menentukan bahwa berbagi file yang dihapus harus disertakan dalam respons. Untuk menentukan lebih dari salah satu opsi ini pada URI, Anda harus memisahkan setiap opsi dengan koma yang dikodekan URL ("%82"). Semua nama metadata harus mematuhi konvensi penamaan untuk pengidentifikasi C# .
`timeout`	Fakultatif. 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.

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

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

Header respons	Deskripsi
`Content-Type`	Header HTTP/1.1 standar. 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.

Isi respons

Format isi respons adalah sebagai berikut.

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults AccountName="https://myaccount.file.core.windows.net">  
  <Prefix>string-value</Prefix>  
  <Marker>string-value</Marker>  
  <MaxResults>int-value</MaxResults>  
  <Shares>  
    <Share>  
      <Name>share-name</Name>  
      <Snapshot>Date-Time Value</Snapshot>
      <Version>01D2AC0C18EDFE36</Version> 
      <Deleted>true</Deleted>  
      <Properties>  
        <Last-Modified>date/time-value</Last-Modified>  
        <Etag>etag</Etag>  
        <Quota>max-share-size</Quota>
        <DeletedTime>Mon, 24 Aug 2020 04:56:10 GMT</DeletedTime>  
        <RemainingRetentionDays>360</RemainingRetentionDays>
        <AccessTier>TransactionOptimized</AccessTier>
        <AccessTierChangeTime>Mon, 24 Aug 2020 03:56:10 GMT</AccessTierChangeTime>
        <AccessTierTransitionState>pending-from-cool</AccessTierTransitionState>
        <EnabledProtocols>SMB</EnabledProtocols>
        <PaidBurstingEnabled>true</PaidBurstingEnabled>
        <PaidBurstingMaxIops>20000</PaidBurstingMaxIops>
        <PaidBurstingMaxBandwidthMibps>4000</PaidBurstingMaxBandwidthMibps>
      </Properties>  
      <Metadata>  
        <metadata-name>value</metadata-name>  
      </Metadata>  
    </Share>  
  </Shares>  
  <NextMarker>marker-value</NextMarker>  
</EnumerationResults>

Elemen EnabledProtocols muncul di isi respons hanya dalam versi 2020-02-10 dan yang lebih baru.
Elemen RootSquash muncul di isi respons hanya dalam versi 2020-02-10 dan yang lebih baru, ketika protokol yang diaktifkan berisi NFS. Elemen ini akan dikembalikan hanya untuk berbagi, bukan untuk rekam jepret.
Elemen Quota muncul di isi respons hanya dalam versi 2015-02-21 dan yang lebih baru.
Elemen Version, Deleted, DeletedTime, dan RemainingRetentionDays muncul di isi respons hanya dalam versi 2019-12-12 dan yang lebih baru.
Elemen Prefix, Marker, dan MaxResults hanya ada jika Anda menentukannya pada URI. Elemen NextMarker memiliki nilai hanya jika hasil daftar tidak selesai.
Elemen Metadata hanya ada jika Anda menentukan parameter include=metadata pada URI. Dalam elemen Metadata, nilai setiap pasangan nama-nilai tercantum dalam elemen yang sesuai dengan nama pasangan.
Rekam jepret disertakan dalam respons hanya jika Anda menentukan parameterinclude=snapshots dengan parameter include pada URI permintaan.
Elemen AccessTier memegang tingkat berbagi. Jika tingkat berbagi belum diubah, properti ini akan menjadi TransactionOptimized tingkat default pada akun penyimpanan versi 2 (GPv2) tujuan umum. Pada akun penyimpanan Azure Files, properti akan Premium, yang merupakan satu-satunya tingkatan yang didukung.
Elemen AccessTierChangeTime hanya ada jika Anda secara eksplisit mengatur tingkat akses pada berbagi.
Elemen AccessTierTransitionState hanya ada jika berbagi beralih dari satu tingkat ke tingkat lainnya. Ini menunjukkan tingkat yang ditransisikannya.
Elemen ProvisionedIngressMBps hanya ada untuk akun Azure Files Premium, dan versi 2019-07-07 atau yang lebih baru. Ini menunjukkan ingress yang disediakan di MiB/dtk.
Elemen ProvisionedEgressMBps hanya ada untuk akun Azure Files Premium, dan versi 2019-07-07 atau yang lebih baru. Ini menunjukkan egress yang disediakan di MiB/s.
Elemen ProvisionedBandwidthMiBps hanya ada untuk akun Azure Files Premium, dan versi 2021-02-12 atau yang lebih baru. Ini menunjukkan bandwidth yang disediakan (ingress + egress combined) di MiB/s.
Elemen EnableSnapshotVirtualDirectoryAccess muncul di isi respons hanya dalam versi 2024-08-04 dan yang lebih baru, ketika protokol yang diaktifkan berisi NFS. Elemen ini akan dikembalikan hanya untuk berbagi, bukan untuk rekam jepret.
Elemen PaidBurstingEnabled hanya ada untuk Premium akun Azure Files, dalam versi 2024-11-04 atau yang lebih baru. Elemen ini akan dikembalikan hanya untuk berbagi, bukan untuk rekam jepret.
Elemen PaidBurstingMaxIops hanya ada untuk Premium akun Azure Files, dalam versi 2024-11-04 atau yang lebih baru. Ini hanya akan dikembalikan jika PaidBurstingEnabled benar untuk berbagi. Elemen ini akan dikembalikan hanya untuk berbagi, bukan untuk rekam jepret.
Elemen PaidBurstingMaxBandwidthMibps hanya ada untuk Premium akun Azure Files, dalam versi 2024-11-04 atau yang lebih baru. Ini hanya akan dikembalikan jika PaidBurstingEnabled benar untuk berbagi. Elemen ini akan dikembalikan hanya untuk berbagi, bukan untuk rekam jepret.

Sampel respons

Lihat bagian permintaan sampel dan respons nanti dalam topik ini.

Otorisasi

Hanya pemilik akun yang dapat memanggil operasi ini.

Komentar

Jika Anda menentukan nilai untuk parameter maxresults, dan jumlah berbagi yang akan dikembalikan melebihi nilai ini, atau melebihi nilai default untuk maxresults, isi respons berisi elemen NextMarker. Elemen ini menunjukkan berbagi berikutnya untuk kembali pada permintaan berikutnya. Untuk mengembalikan kumpulan item berikutnya, tentukan nilai NextMarker sebagai parameter penanda pada URI untuk permintaan berikutnya.

Perhatikan bahwa nilai NextMarker harus diperlakukan sebagai buram.

Berbagi tercantum dalam urutan alfabet dalam isi respons.

Waktu operasi List Shares habis setelah 30 detik.

Contoh permintaan dan respons

Contoh URI berikut meminta daftar berbagi untuk akun. Ini mengatur hasil maksimum untuk mengembalikan operasi awal menjadi tiga.

GET https://myaccount.file.core.windows.net/?comp=list&maxresults=3&include=snapshots HTTP/1.1

Permintaan dikirim dengan header ini:

x-ms-version: 2020-02-10  
x-ms-date: <date>  
Authorization: SharedKey myaccount:CY1OP3O3jGFpYFbTCBimLn0Xov0vt0khH/D5Gy0fXvg=

Kode status dan header respons dikembalikan sebagai berikut:

HTTP/1.1 200 OK  
Transfer-Encoding: chunked  
Content-Type: application/xml  
Date: <date>  
x-ms-version: 2020-02-10  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0

XML respons untuk permintaan ini adalah sebagai berikut. Perhatikan bahwa elemen NextMarker mengikuti sekumpulan berbagi, dan menyertakan nama berbagi berikutnya yang akan dikembalikan.

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults ServiceEndpoint=" https://myaccount.file.core.windows.net">  
  <MaxResults>3</MaxResults>  
  <Shares>  
    <Share>  
      <Name>audio</Name>  
      <Properties>  
        <Last-Modified><date></Last-Modified>  
        <Etag>0x8CACB9BD7C6B1B2</Etag>  
        <Quota>55</Quota>
        <AccessTier>Premium</AccessTier>
        <EnabledProtocols>SMB</EnabledProtocols>
      </Properties>  
    </Share>  
    <Share>  
      <Name>images</Name>  
      <Properties>  
        <Last-Modified><date></Last-Modified>  
        <Etag>0x8CACB9BD7C1EEEC</Etag>
        <AccessTier>Premium</AccessTier>
        <EnabledProtocols>SMB</EnabledProtocols>
      </Properties>  
    </Share>  
    <Share>
      <Name>textfiles</Name>
      <Snapshot>2017-05-12T20:52:22.0000000Z</Snapshot>
      <Properties>
        <Last-Modified><date></Last-Modified>
        <Etag>0x8D3F2E1A9D14700</Etag>
        <Quota>30</Quota>
        <AccessTier>Premium</AccessTier>
        <EnabledProtocols>NFS</EnabledProtocols>
      </Properties>
    </Share>
    <Share>  
      <Name>textfiles</Name>  
      <Properties>  
        <Last-Modified><date></Last-Modified>  
        <Etag>0x8CACB9BD7BACAC3</Etag>  
        <Quota>30</Quota>
        <AccessTier>Premium</AccessTier>
        <EnabledProtocols>NFS</EnabledProtocols>
        <RootSquash>AllSquash</RootSquash>  
      </Properties>  
    </Share>
  </Shares>  
  <NextMarker>video</NextMarker>  
</EnumerationResults>

Operasi daftar berikutnya menentukan penanda pada URI permintaan, sebagai berikut. Kumpulan hasil berikutnya dikembalikan, dimulai dengan berbagi yang ditentukan oleh penanda.

https://myaccount.file.core.windows.net/?comp=list&maxresults=3&marker=video

Lihat juga

AZURE Files REST API

Bagikan melalui