Pobieranie właściwości pliku

Operacja Get File Properties zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości HTTP i właściwości systemu dla pliku. Nie zwraca zawartości pliku.

Dostępność protokołu

Włączony protokół udziału plików Dostępne
SMB Tak
NFS Nie

Żądanie

Żądanie Get File Properties można skonstruować w następujący sposób. Zalecamy używanie protokołu HTTPS.

Metoda Identyfikator URI żądania Wersja PROTOKOŁU HTTP
HEAD https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile HTTP/1.1
HEAD https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?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.
mydirectorypath Opcjonalny. Ścieżka do katalogu nadrzędnego.
myfile Nazwa pliku.

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ą DateTime, która w przypadku obecnej określa migawkę udziału do wykonywania zapytań dotyczących właściwości pliku.
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ń

Wymagane i opcjonalne nagłówki żądań opisano w poniższej tabeli:

Nagłówek żądania Opis
Autoryzacja 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-lease-id:<ID> Opcjonalny. Wersja 2019-02-02 lub nowsza. Jeśli nagłówek jest określony, operacja jest wykonywana tylko wtedy, gdy dzierżawa pliku jest obecnie aktywna, a identyfikator dzierżawy określony w żądaniu jest zgodny z identyfikatorem dzierżawy pliku. Jeśli operacja nie jest zgodna, operacja zakończy się niepowodzeniem z kodem stanu 412 (Warunek wstępny nie powiodło się).
x-ms-client-request-id Opcjonalny. Zapewnia nieprzezroczystą wartość wygenerowaną przez klienta z limitem znaków 1-kibibyte (KiB), który jest rejestrowany w dziennikach analizy po włączeniu rejestrowania w usłudze Azure analityka magazynu. Zdecydowanie zalecamy używanie tego nagłówka podczas korelowania działań po stronie klienta z żądaniami odbieranymi przez serwer. Aby uzyskać więcej informacji, zobacz Monitorowanie Azure Blob Storage.
x-ms-file-request-intent Wymagane, jeśli Authorization nagłówek określa token OAuth. Akceptowalna wartość to backup. Ten nagłówek określa, że wartość Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action lub Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action powinna zostać udzielona, jeśli zostaną one uwzględnione w zasadach RBAC przypisanych do tożsamości, która jest autoryzowana przy użyciu nagłówka Authorization . Dostępne dla wersji 2022-11-02 lub nowszej.
x-ms-allow-trailing-dot: { <Boolean> } Opcjonalny. Wersja 2022-11-02 lub nowsza. Wartość logiczna określa, czy końcowa kropka obecna w adresie URL żądania powinna być przycinana, czy nie. Aby uzyskać więcej informacji, zobacz Nazewnictwo i odwoływanie się do udziałów, katalogów, plików i metadanych.

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 pliku. Format daty jest zgodny z RFC 1123. Aby uzyskać więcej informacji, zobacz Reprezentacja wartości daty/godziny w nagłówkach. Każda operacja, która modyfikuje plik lub jego właściwości, aktualizuje czas ostatniej modyfikacji.
x-ms-meta-name:value Zestaw par name-value skojarzonych z tym plikiem jako metadanych zdefiniowanych przez użytkownika.
x-ms-type: <File> Zwraca typ File. Zarezerwowane do użytku w przyszłości.
Content-Length Rozmiar pliku w bajtach. Ten nagłówek zwraca wartość x-ms-content-length nagłówka przechowywanego w pliku.
Content-Type Typ zawartości określony dla pliku. Jeśli nie określono żadnego typu zawartości, domyślnym typem zawartości jest application/octet-stream.
ETag Element ETag zawiera wartość, której można użyć do warunkowego wykonywania operacji. Wartość jest ujęta w cudzysłów.
Content-MD5 Content-MD5 Jeśli nagłówek został ustawiony dla pliku, Content-MD5 nagłówek odpowiedzi jest zwracany, aby klient mógł sprawdzić integralność zawartości komunikatu.
Content-Encoding Content-Encoding Jeśli nagłówek żądania został wcześniej ustawiony dla pliku, Content-Encoding wartość jest zwracana w tym nagłówku.
Content-Language Content-Language Jeśli nagłówek żądania został wcześniej ustawiony dla pliku, Content-Language wartość jest zwracana w tym nagłówku.
Cache-Control Cache-Control Jeśli nagłówek żądania został wcześniej ustawiony dla pliku, Cache-Control wartość jest zwracana w tym nagłówku.
Content-Disposition Zwraca wartość określoną dla nagłówka x-ms-content-disposition i określa sposób przetwarzania odpowiedzi.

Pole nagłówka Content-Disposition odpowiedzi zawiera dodatkowe informacje o sposobie przetwarzania ładunku odpowiedzi i można go użyć do dołączenia dodatkowych metadanych. Jeśli na przykład ustawiono wartość attachment, Content-Disposition wskazuje, że agent-użytkownik nie powinien wyświetlać odpowiedzi, ale powinien wyświetlić okno Zapisz jako.
x-ms-request-id Unikatowo 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ę usługi, która została użyta do wykonania żądania.
Date Wartość daty/godziny UTC wygenerowana przez usługę, która wskazuje godzinę zainicjowania odpowiedzi.
x-ms-copy-completion-time:<datetime> Wersja 2015-02-21 lub nowsza. Czas zakończenia ostatniej próby skopiowania pliku , w którym ten plik był plikiem docelowym. Ta wartość może określać czas ukończenia, przerwania lub nieudanej próby kopiowania. Ten nagłówek nie jest wyświetlany, jeśli kopia jest oczekująca, jeśli ten plik nigdy nie był miejscem docelowym operacji kopiowania pliku lub jeśli ten plik został zmodyfikowany po zakończeniu operacji kopiowania pliku za pomocą polecenia Ustaw właściwości pliku lub Utwórz plik.
x-ms-copy-status-description: <error string> Wersja 2015-02-21 lub nowsza. Pojawia się tylko wtedy, gdy x-ms-copy-statusniepowodzenie lub oczekiwanie. Opisuje przyczynę błędu operacji kopiowania krytycznego lub niekrytycznego. Ten nagłówek nie jest wyświetlany, jeśli kopia jest oczekująca, jeśli ten plik nigdy nie był miejscem docelowym operacji kopiowania pliku lub jeśli ten plik został zmodyfikowany po zakończeniu operacji kopiowania pliku za pomocą polecenia Ustaw właściwości pliku lub Utwórz plik.
x-ms-copy-id: <id> Wersja 2015-02-21 lub nowsza. Identyfikator ciągu ostatniej próby operacji kopiowania pliku , w której ten plik był plikiem docelowym. Ten nagłówek nie jest wyświetlany, jeśli ten plik nigdy nie był miejscem docelowym w operacji kopiowania pliku lub jeśli ten plik został zmodyfikowany po zakończeniu operacji kopiowania pliku za pomocą polecenia Ustaw właściwości pliku lub Utwórz plik.
x-ms-copy-progress: <bytes copied/bytes total> Wersja 2015-02-21 lub nowsza. Zawiera liczbę skopiowanych bajtów oraz łączną liczbę bajtów w źródle podczas ostatniej próby operacji kopiowania pliku , w której ten plik był plikiem docelowym. Może pokazywać od 0 do liczby skopiowanych bajtów Content-Length . Ten nagłówek nie jest wyświetlany, jeśli ten plik nigdy nie był miejscem docelowym w operacji kopiowania pliku lub jeśli ten plik został zmodyfikowany po zakończeniu operacji kopiowania pliku za pomocą polecenia Ustaw właściwości pliku lub Utwórz plik.
x-ms-copy-source: url Wersja 2015-02-21 lub nowsza. Adres URL zawierający maksymalnie 2 KB znaków określający plik źródłowy, który został użyty podczas ostatniej próby operacji kopiowania pliku , w której był to plik docelowy. Ten nagłówek nie jest wyświetlany, jeśli ten plik nigdy nie był miejscem docelowym w operacji kopiowania pliku lub jeśli ten plik został zmodyfikowany po zakończeniu operacji kopiowania pliku za pomocą polecenia Ustaw właściwości pliku lub Utwórz plik.
x-ms-copy-status: <pending ¦ success ¦ aborted ¦ failed> Wersja 2015-02-21 lub nowsza. Stan operacji kopiowania, która jest identyfikowana przez x-ms-copy-idelement , z następującymi wartościami:

- Sukces: Kopiowanie zostało ukończone pomyślnie.
- Oczekujące: Kopiowanie jest w toku. Sprawdź x-ms-copy-status-description , czy sporadyczne błędy niekrytyczne utrudniają postęp kopiowania, ale nie powodują niepowodzenia.
- Przerwane: Kopiowanie zostało zakończone przez przerwanie kopiowania pliku.
- Nie powiodło się: Kopiowanie nie powiodło się. Zobacz x-ms-copy-status-description , aby uzyskać szczegółowe informacje o błędach.

Ten nagłówek nie jest wyświetlany, jeśli ten plik nigdy nie był miejscem docelowym w operacji kopiowania pliku lub jeśli ten plik został zmodyfikowany po zakończeniu operacji kopiowania pliku za pomocą polecenia Ustaw właściwości pliku lub Utwórz plik.
x-ms-server-encrypted: true/false Wersja 2017-04-17 lub nowsza. Wartość tego nagłówka jest ustawiana na true wartość , jeśli dane pliku i metadane aplikacji są całkowicie szyfrowane przy użyciu określonego algorytmu. Wartość jest ustawiana na false wartość , jeśli plik jest niezaszyfrowany lub jeśli zaszyfrowane są tylko części pliku lub metadanych aplikacji.
x-ms-file-permission-key Wersja 2019-02-02 lub nowsza. Klucz uprawnienia do pliku.
x-ms-file-attributes Wersja 2019-02-02 lub nowsza. Atrybuty systemu plików pliku. Aby uzyskać więcej informacji, zobacz listę dostępnych atrybutów.
x-ms-file-creation-time Wersja 2019-02-02 lub nowsza. Wartość daty/godziny UTC reprezentująca właściwość godziny utworzenia pliku.
x-ms-file-last-write-time Wersja 2019-02-02 lub nowsza. Wartość daty/godziny UTC reprezentująca właściwość godziny ostatniego zapisu dla pliku.
x-ms-file-change-time Wersja 2019-02-02 lub nowsza. Wartość daty/godziny UTC reprezentująca właściwość godziny zmiany pliku.
x-ms-file-file-id Wersja 2019-02-02 lub nowsza. Identyfikator pliku.
x-ms-file-parent-id Wersja 2019-02-02 lub nowsza. Identyfikator pliku nadrzędnego.
x-ms-lease-duration:infinite Wersja 2019-02-02 lub nowsza. Gdy plik jest dzierżawiony, określa, że dzierżawa ma nieskończony czas trwania.
x-ms-lease-state:<available;leased;broken> Wersja 2019-02-02 lub nowsza. Gdy plik jest dzierżawiony, określa stan dzierżawy pliku.
x-ms-lease-status:<locked;unlocked> Wersja 2019-02-02 lub nowsza. Gdy plik jest dzierżawiony, określa stan dzierżawy pliku.
x-ms-client-request-id Może służyć do rozwiązywania problemów z żądaniami i odpowiadającymi odpowiedziami. Wartość tego nagłówka jest równa wartości x-ms-client-request-id nagłówka, jeśli jest obecna w żądaniu, a wartość zawiera nie więcej niż 1024 widoczne znaki ASCII. x-ms-client-request-id Jeśli nagłówek nie znajduje się w żądaniu, nie jest obecny w odpowiedzi.

Treść odpowiedzi

Brak.

Przykładowa odpowiedź

Response Status:  
HTTP/1.1 200 OK  
  
Response Headers:  
x-ms-type: File  
x-ms-meta-m1: v1  
x-ms-meta-m2: v2  
Content-Length: 11  
Content-Type: text/plain; charset=UTF-8  
Date: <date>  
ETag: "0x8CB171DBEAD6A6B"  
Last-Modified: <date>  
x-ms-version: 2019-02-02  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0  
x-ms-copy-id: 36650d67-05c9-4a24-9a7d-a2213e53caf6  
x-ms-copy-source: <url>  
x-ms-copy-status: success  
x-ms-copy-progress: 11/11  
x-ms-copy-completion-time: <date>  
x-ms-lease-duration: infinite   
x-ms-lease-state: leased 
x-ms-lease-status: locked   
  

Autoryzacja

Tylko właściciel konta może wywołać tę operację.

Zobacz też

Operacje na Azure Files