Uzyskiwanie właściwości udziału
Get Share Properties
Żądanie zwraca właściwości dla określonego udziału lub migawki udziału.
Mimo że ten interfejs API jest w pełni obsługiwany, jest to starszy interfejs API zarządzania. Z tego powodu zalecamy użycie udziałów plików — Pobierz, który jest dostarczany przez dostawcę zasobów magazynu (Microsoft.Storage), zamiast tego.
Aby dowiedzieć się więcej o programowej interakcji z FileShare
zasobami przy użyciu dostawcy zasobów magazynu, zobacz Operacje na udziałach plików.
Dostępność protokołu
Włączony protokół udziału plików | Dostępne |
---|---|
SMB | |
NFS |
Żądanie
Żądanie Get Share Properties
można skonstruować w następujący sposób. Zalecamy używanie protokołu HTTPS.
Metoda | Identyfikator URI żądania | Wersja PROTOKOŁU 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 |
Zastąp składniki ścieżki wyświetlane we własnym identyfikatorze URI żądania, w następujący sposób:
Składnik ścieżki | Opis |
---|---|
myaccount |
Nazwa konta magazynu. |
myshare |
Nazwa udziału plików. |
Aby uzyskać informacje na temat ograniczeń nazewnictwa ścieżek, zobacz Nazwy i udziały referencyjne, katalogi, pliki i metadane.
Parametry identyfikatora URI
W identyfikatorze URI żądania można określić następujące dodatkowe parametry:
Parametr | Opis |
---|---|
sharesnapshot |
Opcjonalny. Wersja 2017-04-17 lub nowsza. Parametr sharesnapshot jest nieprzezroczystą wartością daty/godziny, która w chwili obecnej określa migawkę udziału, aby wykonać zapytanie w celu pobrania właściwości. |
timeout |
Opcjonalny. Parametr limitu czasu jest wyrażony w sekundach. Aby uzyskać więcej informacji, zobacz Ustawianie limitów czasu dla operacji Azure Files. |
Nagłówki żądań
Wymagane i opcjonalne nagłówki opisano w poniższej tabeli:
Nagłówek żądania | Opis |
---|---|
Authorization |
Wymagane. Określa schemat autoryzacji, nazwę konta i podpis. Aby uzyskać więcej informacji, zobacz Autoryzowanie żądań do usługi Azure Storage. |
Date lub x-ms-date |
Wymagane. Określa dla żądania godzinę w formacie uniwersalnego czasu koordynowanego (UTC). Aby uzyskać więcej informacji, zobacz Autoryzowanie żądań do usługi Azure Storage. |
x-ms-version |
Wymagane dla wszystkich autoryzowanych żądań. Określa wersję operacji do użycia dla tego żądania. Aby uzyskać więcej informacji, zobacz Przechowywanie wersji usług Azure Storage. |
x-ms-client-request-id |
Opcjonalny. Udostępnia nieprzezroczystą wartość wygenerowaną przez klienta z limitem znaków 1-kibibyte (KiB), który jest rejestrowany w dziennikach podczas konfigurowania rejestrowania. Zdecydowanie zalecamy używanie tego nagłówka do korelowania działań po stronie klienta z żądaniami odbieranymi przez serwer. Aby uzyskać więcej informacji, zobacz Monitorowanie Azure Files. |
x-ms-lease-id:<ID> |
Opcjonalny. Wersja 2020-02-10 lub nowsza. Jeśli nagłówek jest określony, operacja jest wykonywana tylko wtedy, gdy dzierżawa udziału plików jest obecnie aktywna, a identyfikator dzierżawy określony w żądaniu jest zgodny z identyfikatorem dzierżawy udziału plików. Jeśli nie ma dopasowania, operacja kończy się niepowodzeniem z kodem stanu 412 (Warunek wstępny nie powiodło się). |
Treść żądania
Brak.
Reakcja
Odpowiedź zawiera kod stanu HTTP i zestaw nagłówków odpowiedzi.
Kod stanu
Operacja zakończona powodzeniem zwraca kod stanu 200 (OK).
Aby uzyskać więcej informacji na temat kodów stanu, zobacz Kody stanu i błędów.
Nagłówki odpowiedzi
Odpowiedź na tę operację zawiera następujące nagłówki. Odpowiedź może również zawierać dodatkowe standardowe nagłówki HTTP. Wszystkie nagłówki standardowe są zgodne ze specyfikacją protokołu HTTP/1.1.
Nagłówek odpowiedzi | Opis |
---|---|
Last-Modified |
Zwraca datę i godzinę ostatniej modyfikacji udziału. Format daty jest zgodny z RFC 1123. Aby uzyskać więcej informacji, zobacz Reprezentacja wartości Date-Time w nagłówkach. Każda operacja modyfikując udział lub jego właściwości aktualizuje czas ostatniej modyfikacji. Operacje na plikach nie wpływają na czas ostatniej modyfikacji udziału. |
x-ms-meta-name:value |
Zestaw par nazwa-wartość, które zawierają metadane zdefiniowane przez użytkownika udziału. |
ETag |
Zawiera wartość, której można użyć do warunkowego wykonywania operacji. Wartość jest ujęta w cudzysłów. |
x-ms-request-id |
Jednoznacznie identyfikuje wykonane żądanie i może służyć do rozwiązywania problemów z żądaniem. Aby uzyskać więcej informacji, zobacz Rozwiązywanie problemów z operacjami interfejsu API. |
x-ms-version |
Wersja Azure Files użyta do wykonania żądania. |
Date |
Wartość daty/godziny UTC wygenerowana przez usługę, która wskazuje godzinę zainicjowania odpowiedzi. |
x-ms-share-quota |
Wersja 2015-02-21 lub nowsza. Zwraca bieżący limit przydziału udziału w gibibajtach (GiB). |
x-ms-share-provisioned-iops |
Wersja 2019-07-07 lub nowsza. Zwrócone tylko dla udziałów plików w warstwie Premium (udziały plików w ramach typu konta magazynu FileStorage). Zwraca liczbę operacji wejściowych/wyjściowych na sekundę (IOPS) aprowizowaną dla udziału w warstwie Premium. |
x-ms-share-provisioned-ingress-mbps |
Wersja 2019-07-07 lub nowsza. Zwrócone tylko dla udziałów plików w warstwie Premium (udziały plików w ramach typu konta magazynu FileStorage). Zwraca ruch przychodzący w mebibajtach na sekundę (MiB/s), zgodnie z aprowizowaną dla udziału w warstwie Premium. |
x-ms-share-provisioned-egress-mbps |
Wersja 2019-07-07 lub nowsza. Zwrócone tylko dla udziałów plików w warstwie Premium (udziały plików w ramach typu konta magazynu FileStorage). Zwraca ruch wychodzący w usłudze MiB/s, zgodnie z aprowizowaną dla udziału w warstwie Premium. |
x-ms-share-provisioned-bandwidth-mibps |
Wersja 2021-02-12 lub nowsza. Zwrócone tylko dla udziałów plików w warstwie Premium (udziały plików w ramach typu konta magazynu FileStorage). Zwraca łączną przepustowość (ruch przychodzący i ruch wychodzący) w usłudze MiB/s, zgodnie z aprowizowaną dla udziału w warstwie Premium. |
x-ms-share-next-allowed-quota-downgrade-time |
Wersja 2019-07-07 lub nowsza. Zwrócone tylko dla udziałów plików w warstwie Premium (udziały plików w ramach typu konta magazynu FileStorage). Wartość daty/godziny określająca, kiedy limit przydziału udziału plików w warstwie Premium może zostać zmniejszony. Format daty jest zgodny z RFC 1123. |
x-ms-access-tier |
Wersja 2019-12-12 lub nowsza. Zwraca bieżącą warstwę dostępu udziału. W przypadku kont TransationOptimized magazynu ogólnego przeznaczenia w wersji 2 (GPv2) jest domyślną warstwą udziału. W obszarze FileStorage storage account types ( Premium Typy kont magazynu FileStorage) jest domyślną warstwą udziału. |
x-ms-access-tier-change-time |
Wersja 2019-12-12 lub nowsza. Zwraca datę i godzinę ostatniej modyfikacji warstwy dostępu w udziale. |
x-ms-access-tier-transition-state |
Wersja 2019-12-12 lub nowsza. Jeśli udział przechodzi przejście do warstwy, ten nagłówek wskazuje warstwę, z której przechodzi. |
x-ms-lease-duration:<fixed,infinite> |
Wersja 2020-02-10 lub nowsza. Określa, czy dzierżawa udziału ma nieskończony lub stały czas trwania. |
x-ms-lease-state: <available;leased;expired;breaking;broken> |
Wersja 2020-02-10 lub nowsza. Gdy udział jest dzierżawiony, ten nagłówek określa stan dzierżawy udziału. |
x-ms-lease-status: <locked;unlocked> |
Wersja 2020-02-10 lub nowsza. Gdy udział jest dzierżawiony, ten nagłówek określa stan dzierżawy udziału. |
x-ms-enabled-protocols: <SMB;NFS> |
Zwraca bieżące protokoły z obsługą udziału dla wersji 2019-07-07 i nowszych. - SMB : Dostęp do udziału można uzyskać za pomocą protokołu SMBv3.0, SMBv2.1 i REST.- NFS : dostęp do udziału można uzyskać za pomocą systemu plików NFSv4.1. |
x-ms-root-squash: <NoRootSquash;RootSquash;AllSquash> |
Zwraca bieżące zachowanie z powodu zmiażdzania katalogu głównego udziału dla wersji 2019-07-07 i nowszych. Tylko system plików NFS. - NoRootSquash : Root squashing is off.- RootSquash : Żądania z identyfikatora UID/GID 0 są mapowane na anonimowy identyfikator UID/GID.- AllSquash : wszystkie identyfikatory UID i GID są mapowane na użytkownika anonimowego. |
x-ms-client-request-id |
Może służyć do rozwiązywania problemów z żądaniami i odpowiadającymi im odpowiedziami. Wartość tego nagłówka jest równa wartości x-ms-client-request-id nagłówka, jeśli znajduje się w żądaniu, a wartość nie zawiera więcej niż 1024 widocznych znaków ASCII. x-ms-client-request-id Jeśli nagłówek nie jest obecny w żądaniu, nie będzie on obecny w odpowiedzi. |
Treść odpowiedzi
Brak.
Przykładowa odpowiedź
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
Autoryzacja
Tylko właściciel konta może wywołać tę operację.
Uwagi
Brak.