Pobieranie metadanych udziału
Operacja Get Share Metadata zwraca wszystkie metadane zdefiniowane przez użytkownika dla udziału plików platformy Azure 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 w udziałach plików platformy Azure.
Dostępność protokołu
| Włączony protokół udziału plików | Dostępne |
|---|---|
| SMB |
|
| NFS |
|
Żądanie
Żądanie Get Share Metadata jest konstruowane 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&comp=metadata |
HTTP/1.1 |
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata&sharesnapshot=<DateTime> |
HTTP/1.1 |
Zastąp składniki ścieżki wyświetlane w identyfikatorze URI żądania własnymi elementami 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 metadanych |
timeout |
Opcjonalny. Parametr jest wyrażony timeout w sekundach. Aby uzyskać więcej informacji, zobacz Ustawianie limitów czasu dla operacji Azure Files. |
Nagłówki żądań
| 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 daty/godziny 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 dla 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 |
Wskazuje wersję Azure Files, która została użyta do wykonania żądania. |
Date lub x-ms-date |
Wartość daty/godziny UTC wygenerowana przez usługę, która wskazuje godzinę zainicjowania odpowiedzi. |
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: somemetadata
Date: Mon, 27 Jan 2014 22:49:18 GMT
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: Mon, 27 Jan 2014 22:48:29 GMT
x-ms-version: 2014-02-14
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
Autoryzacja
Tylko właściciel konta może wywołać tę operację.
Uwagi
Ta operacja zwraca tylko metadane zdefiniowane przez użytkownika w udziale. Aby również zwrócić właściwości systemu, wywołaj metodę Pobierz właściwości udziału.