Mendapatkan Properti Berbagi
Permintaan Get Share Properties mengembalikan properti untuk rekam jepret berbagi atau berbagi yang ditentukan.
Meskipun API ini didukung penuh, API ini adalah API manajemen warisan. Untuk alasan ini, kami sarankan Anda menggunakan berbagi file - Dapatkan, yang disediakan oleh penyedia sumber daya penyimpanan (Microsoft.Storage), sebagai gantinya.
Untuk mempelajari selengkapnya tentang berinteraksi secara terprogram dengan sumber daya FileShare menggunakan penyedia sumber daya penyimpanan, lihat Operasi di FileShares.
Ketersediaan protokol
| Protokol berbagi file yang diaktifkan | Tersedia |
|---|---|
| SMB |
|
| NFS |
|
Minta
Permintaan Get Share Properties dapat dibuat sebagai berikut. Kami menyarankan agar Anda menggunakan HTTPS.
| Metode | Meminta URI | Versi HTTP |
|---|---|---|
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share |
HTTP/1.1 |
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share&sharesnapshot=<DateTime> |
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. |
Untuk informasi tentang pembatasan penamaan jalur, lihat Nama dan berbagi referensi, direktori, file, dan metadata.
Parameter URI
Parameter tambahan berikut dapat ditentukan dalam URI permintaan:
| Parameter | Deskripsi |
|---|---|
sharesnapshot |
Fakultatif. Versi 2017-04-17 dan yang lebih baru. Parameter sharesnapshot adalah nilai tanggal/waktu buram yang, saat ada, menentukan salinan bayangan berbagi untuk dikueri untuk mengambil properti. |
timeout |
Fakultatif. Parameter batas waktu dinyatakan dalam detik. Untuk informasi selengkapnya, lihat Mengatur batas waktu untuk operasi Azure Files. |
Header permintaan
Header yang diperlukan dan opsional dijelaskan dalam tabel berikut:
| 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. |
x-ms-lease-id:<ID> |
Fakultatif. Versi 2020-02-10 dan yang lebih baru. Jika header ditentukan, operasi dilakukan hanya jika sewa berbagi file saat ini aktif dan ID sewa yang ditentukan dalam permintaan cocok dengan ID sewa berbagi file. Jika tidak ada kecocokan, operasi gagal dengan kode status 412 (Prasyarat Gagal). |
Isi permintaan
Tidak.
Jawaban
Respons mencakup kode status HTTP dan sekumpulan header respons.
Kode status
Operasi yang berhasil mengembalikan kode status 200 (OK).
Untuk informasi selengkapnya tentang kode status, lihat Status dan kode 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 |
|---|---|
Last-Modified |
Mengembalikan tanggal dan waktu saat berbagi terakhir diubah. Format tanggal mengikuti RFC 1123. Untuk informasi selengkapnya, lihat Representasi Nilai Date-Time di Header. Setiap operasi yang memodifikasi berbagi atau propertinya memperbarui waktu terakhir diubah. Operasi pada file tidak memengaruhi waktu terakhir berbagi yang dimodifikasi. |
x-ms-meta-name:value |
Sekumpulan pasangan nilai nama yang berisi metadata berbagi yang ditentukan pengguna. |
ETag |
Berisi nilai yang dapat Anda gunakan untuk melakukan operasi secara kondisional. Nilai diapit dalam tanda kutip. |
x-ms-request-id |
Secara unik mengidentifikasi permintaan yang dibuat dan dapat digunakan untuk memecahkan masalah permintaan. Untuk informasi selengkapnya, lihat Memecahkan masalah operasi API. |
x-ms-version |
Versi Azure Files yang digunakan untuk menjalankan permintaan. |
Date |
Nilai tanggal/waktu UTC yang dihasilkan oleh layanan, yang menunjukkan waktu ketika respons dimulai. |
x-ms-share-quota |
Versi 2015-02-21 dan yang lebih baru. Mengembalikan kuota berbagi saat ini dalam gibibyte (GiB). |
x-ms-share-provisioned-iops |
Versi 2019-07-07 dan yang lebih baru. Dikembalikan hanya untuk berbagi file premium (berbagi file dalam jenis akun penyimpanan FileStorage). Mengembalikan jumlah operasi input/output per detik (IOPS), seperti yang disediakan untuk berbagi premium. |
x-ms-share-provisioned-ingress-mbps |
Versi 2019-07-07 dan yang lebih baru. Dikembalikan hanya untuk berbagi file premium (berbagi file dalam jenis akun penyimpanan FileStorage). Mengembalikan ingress dalam mebibyte per detik (MiB/s), seperti yang disediakan untuk berbagi premium. |
x-ms-share-provisioned-egress-mbps |
Versi 2019-07-07 dan yang lebih baru. Dikembalikan hanya untuk berbagi file premium (berbagi file dalam jenis akun penyimpanan FileStorage). Mengembalikan egress di MiB/s, seperti yang disediakan untuk berbagi premium. |
x-ms-share-provisioned-bandwidth-mibps |
Versi 2021-02-12 dan yang lebih baru. Dikembalikan hanya untuk berbagi file premium (berbagi file dalam jenis akun penyimpanan FileStorage). Mengembalikan bandwidth gabungan (ingress + egress) di MiB/dtk, seperti yang disediakan untuk berbagi premium. |
x-ms-share-next-allowed-quota-downgrade-time |
Versi 2019-07-07 dan yang lebih baru. Dikembalikan hanya untuk berbagi file premium (berbagi file dalam jenis akun penyimpanan FileStorage). Nilai tanggal/waktu yang menentukan kapan kuota untuk berbagi file premium diizinkan untuk dikurangi. Format tanggal mengikuti RFC 1123. |
x-ms-access-tier |
Versi 2019-12-12 dan yang lebih baru. Mengembalikan tingkat akses berbagi saat ini. Dalam akun penyimpanan versi 2 (GPv2) tujuan umum, TransationOptimized adalah tingkat default berbagi. Di jenis akun penyimpanan FileStorage, Premium adalah tingkat default berbagi. |
x-ms-access-tier-change-time |
Versi 2019-12-12 dan yang lebih baru. Mengembalikan tanggal dan waktu saat tingkat akses pada berbagi terakhir diubah. |
x-ms-access-tier-transition-state |
Versi 2019-12-12 dan yang lebih baru. Jika berbagi sedang mengalami transisi tingkat, header ini menunjukkan tingkat transisinya. |
x-ms-lease-duration:<fixed,infinite> |
Versi 2020-02-10 dan yang lebih baru. Menentukan apakah sewa pada berbagi memiliki durasi tak terbatas atau tetap. |
x-ms-lease-state: <available;leased;expired;breaking;broken> |
Versi 2020-02-10 dan yang lebih baru. Ketika berbagi disewakan, header ini menentukan status sewa berbagi. |
x-ms-lease-status: <locked;unlocked> |
Versi 2020-02-10 dan yang lebih baru. Ketika berbagi disewakan, header ini menentukan status sewa berbagi. |
x-ms-enabled-protocols: <SMB;NFS> |
Mengembalikan protokol yang diaktifkan berbagi saat ini untuk versi 2019-07-07 dan yang lebih baru. - SMB: Berbagi dapat diakses oleh SMBv3.0, SMBv2.1, dan REST.- NFS: Berbagi dapat diakses oleh NFSv4.1. |
x-ms-root-squash: <NoRootSquash;RootSquash;AllSquash> |
Mengembalikan perilaku pembagi akar berbagi saat ini untuk versi 2019-07-07 dan yang lebih baru. Hanya NFS. - NoRootSquash: Root squashing nonaktif.- RootSquash: Permintaan dari UID/GID 0 dipetakan ke UID/GID anonim.- AllSquash: Semua UID dan GID dipetakan ke pengguna anonim.Header ini dikembalikan hanya untuk berbagi, bukan untuk rekam jepret. |
x-ms-enable-snapshot-virtual-directory-access: <true;false> |
Versi 2024-08-04 dan yang lebih baru. Menentukan apakah direktori virtual rekam jepret harus dapat diakses di akar titik pemasangan berbagi saat NFS diaktifkan. Header ini dikembalikan hanya untuk berbagi, bukan untuk rekam jepret. |
x-ms-client-request-id |
Dapat digunakan untuk memecahkan masalah permintaan dan respons yang sesuai. Nilai header ini sama dengan nilai header x-ms-client-request-id jika ada dalam permintaan dan nilai berisi tidak lebih dari 1.024 karakter ASCII yang terlihat. Jika header x-ms-client-request-id tidak ada dalam permintaan, header tersebut tidak akan ada dalam respons. |
x-ms-share-paid-bursting-enabled: <true;false> |
Versi 2024-11-04 dan yang lebih baru. Dikembalikan hanya untuk berbagi file premium (berbagi file dalam jenis akun penyimpanan FileStorage). Menentukan apakah bursting berbayar diaktifkan. Header ini dikembalikan hanya untuk berbagi, bukan untuk rekam jepret. |
x-ms-share-paid-bursting-max-iops |
Versi 2024-11-04 dan yang lebih baru. Dikembalikan hanya untuk berbagi file premium. Mengembalikan IOPS bursting berbayar maksimum yang diizinkan untuk berbagi. Hanya dikembalikan jika x-ms-share-paid-bursting-enabled benar.Header ini dikembalikan hanya untuk berbagi, bukan untuk rekam jepret. |
x-ms-share-paid-bursting-max-bandwidth-mibps |
Versi 2024-11-04 dan yang lebih baru. Dikembalikan hanya untuk berbagi file premium. Mengembalikan MiB bursting berbayar maksimum yang diizinkan untuk berbagi. Hanya dikembalikan jika x-ms-share-paid-bursting-enabled benar.Header ini dikembalikan hanya untuk berbagi, bukan untuk rekam jepret. |
Isi respons
Tidak.
Sampel respons
Response Status:
HTTP/1.1 200 OK
Response Headers:
Transfer-Encoding: chunked
x-ms-meta-name: some_metadata
Date: <date>
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: <date>
x-ms-share-quota: 1024
x-ms-access-tier: Premium
x-ms-version: 2020-02-10
x-ms-enabled-protocols: NFS
x-ms-root-squash: RootSquash
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
Otorisasi
Hanya pemilik akun yang dapat memanggil operasi ini.
Komentar
Tidak.
Lihat juga
operasi pada berbagi file Azure