Pobieranie pliku
Operacja Get File odczytuje lub pobiera plik z systemu, w tym jego metadane i właściwości.
Dostępność protokołu
| Włączony protokół udziału plików | Dostępne |
|---|---|
| SMB |
|
| NFS |
|
Żądanie
Żądanie Get File może być skonstruowane w następujący sposób. Zalecamy korzystanie z protokołu HTTPS.
| Metoda | Identyfikator URI żądania | Wersja PROTOKOŁU HTTP |
|---|---|---|
GET |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile |
HTTP/1.1 |
Zastąp składniki ścieżki, które są wyświetlane w identyfikatorze URI żądania własnym, 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. |
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
Dla identyfikatora URI żądania można określić następujące dodatkowe parametry:
| Parametr | Opis |
|---|---|
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ń zostały opisane 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 dla usług Azure Storage. |
Range |
Opcjonalny. Zwraca dane pliku tylko z określonego zakresu bajtów. |
x-ms-range |
Opcjonalny. Zwraca dane pliku tylko z określonego zakresu bajtów. Jeśli określono obie Range wartości i x-ms-range , usługa używa wartości x-ms-range. Jeśli żadna z nich nie zostanie określona, zostanie zwrócona cała zawartość pliku. Aby uzyskać więcej informacji, zobacz Określanie nagłówka zakresu dla operacji Azure Files. |
x-ms-range-get-content-md5: true |
Opcjonalny. Gdy ten nagłówek jest ustawiony na true wartość i jest określony wraz z nagłówkiem Range , usługa zwraca skrót MD5 dla zakresu, o ile zakres jest mniejszy lub równy 4 mebibajtów (MiB) w rozmiarze.Jeśli ten nagłówek jest określony bez nagłówka Range , usługa zwraca kod stanu 400 (Nieprawidłowe żądanie).Jeśli ten nagłówek jest ustawiony na true wartość , gdy zakres przekracza 4 miB w rozmiarze, usługa zwraca kod stanu 400 (Nieprawidłowe żądanie). |
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. W przeciwnym razie operacja kończy się niepowodzeniem z kodem stanu 412 (Niepowodzenie warunku wstępnego). |
x-ms-client-request-id |
Opcjonalny. Zapewnia nieprzezroczystą wartość wygenerowaną przez klienta z limitem znaków 1-kibibyte (KiB) rejestrowanym 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-file-request-intent |
Wymagane, jeśli Authorization nagłówek określa token OAuth. Akceptowalna wartość to backup. Ten nagłówek określa, czy Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action element lub Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action ma zostać przyznany, jeśli są 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 zostać przycięta, 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, zestaw nagłówków odpowiedzi i treść odpowiedzi, która zawiera zawartość pliku.
Kod stanu
Pomyślna operacja zwraca kod stanu 200 (OK).
Aby uzyskać informacje o kodach stanu, zobacz Status and Error Codes (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 standardowe nagłówki 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 dokumentem RFC 1123. Aby uzyskać więcej informacji, zobacz Reprezentacja wartości daty/godziny w nagłówkach. Każda operacja modyfikując plik lub jego właściwości aktualizuje czas ostatniej modyfikacji. |
x-ms-meta-name:value |
Zestaw par nazwa-wartość skojarzonych z tym plikiem jako metadanych zdefiniowanych przez użytkownika. |
Content-Length |
Liczba bajtów obecnych w treści odpowiedzi. |
Content-Type |
Typ zawartości określony dla pliku. Domyślnym typem zawartości jest application/octet-stream. |
Content-Range |
Zakres bajtów zwracany, jeśli klient zażądał podzestawu pliku, ustawiając Range nagłówek żądania. |
ETag |
Zawiera wartość, której można użyć do warunkowego wykonywania operacji. Wartość jest ujęta w znaki cudzysłowu. |
Content-MD5 |
Jeśli plik ma skrót MD5 i żądanie jest odczytanie pełnego pliku, ten nagłówek odpowiedzi jest zwracany, aby klient mógł sprawdzić integralność zawartości wiadomości. Jeśli żądanie ma odczytać określony zakres i x-ms-range-get-content-md5 jest ustawione truena , żądanie zwraca skrót MD5 dla zakresu, o ile rozmiar zakresu jest mniejszy lub równy 4 MiB.Jeśli żaden z tych zestawów warunków nie jest truezwracany, żadna wartość nie jest zwracana dla nagłówka Content-MD5 .Jeśli x-ms-range-get-content-md5 jest określony bez nagłówka zakresu, usługa zwraca kod stanu 400 (Nieprawidłowe żądanie).Jeśli x-ms-range-get-content-md5 jest ustawiona wartość true , gdy zakres przekracza 4 miB, usługa zwraca kod stanu 400 (nieprawidłowe żądanie). |
Content-Encoding |
Zwraca wartość, która została określona dla nagłówka Content-Encoding żądania. |
Content-Language |
Zwraca wartość, która została określona dla nagłówka Content-Language żądania. |
Cache-Control |
Jest zwracany, jeśli został wcześniej określony dla pliku. |
Content-Disposition |
Zwraca wartość, która została określona dla nagłówka x-ms-content-disposition i określa sposób przetwarzania odpowiedzi.Pole nagłówka Content-Disposition odpowiedzi przekazuje dodatkowe informacje na temat przetwarzania ładunku odpowiedzi, a także może służyć do dołączania dodatkowych metadanych. Jeśli na przykład ustawiono attachmentwartość , Content-Disposition wskazuje, że agent-użytkownik nie powinien wyświetlać odpowiedzi, ale zamiast tego powinien wyświetlić okno Zapisz jako. |
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 usługi, która została użyta do wykonania żądania. |
Accept-Ranges: bytes |
Wskazuje, że usługa obsługuje żądania częściowej zawartości pliku. |
Date |
Date |
x-ms-copy-completion-time:<datetime> |
Wersja 2015-02-21 lub nowsza. Czas 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ńczonej operacji kopiowania pliku , która użyła ustawienia 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ę krytycznej lub niekrytycznej operacji kopiowania. Ten nagłówek nie pojawia się, 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 , która użyła ustawiania właściwości pliku lub tworzenia pliku. |
x-ms-copy-id: <id> |
Wersja 2015-02-21 lub nowsza. Identyfikator ciągu ostatniej próby skopiowania pliku , w którym ten plik był plikiem docelowym. Ten nagłówek nie jest wyświetlany, jeśli plik nigdy nie był miejscem docelowym operacji kopiowania pliku lub jeśli ten plik został zmodyfikowany po zakończeniu operacji kopiowania pliku, która użyła ustawiania właściwości pliku lub tworzenia pliku. |
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 w ostatniej operacji kopiowania pliku , w której ten plik był plikiem docelowym. Może pokazywać od 0 do liczby skopiowanych Content-Length bajtów. Ten nagłówek nie pojawia się, 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 , która użyła ustawiania właściwości pliku lub tworzenia pliku. |
x-ms-copy-source: url |
Wersja 2015-02-21 lub nowsza. Adres URL o długości do 2 KB, który określa plik źródłowy, który został użyty w ostatniej operacji kopiowania pliku , gdzie 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ńczonej operacji kopiowania pliku, która użyła ustawiania właściwości pliku lub tworzenia pliku. |
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:- pending: Kopiowanie jest w toku. Sprawdź x-ms-copy-status-description , czy sporadyczne błędy niekrytyczne utrudniają postęp kopiowania, ale nie powodują awarii.- success: Kopiowanie zostało ukończone pomyślnie.- aborted: Kopiowanie zostało zakończone przez przerwanie kopiowania pliku.- failed: Kopiowanie nie powiodło się. Aby uzyskać szczegółowe informacje o błędach, zobacz x-ms-copy-status-description .Ten nagłówek nie jest wyświetlany, 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 , która używała ustawiania właściwości pliku lub tworzenia pliku. |
x-ms-content-md5 |
Od wersji 2016-05-31, jeśli plik ma skrót MD5, a jeśli żądanie zawiera nagłówek zakresu (range lub x-ms-range), ten nagłówek odpowiedzi jest zwracany z wartością wartości MD5 całego pliku. Ta wartość może lub nie jest równa wartości zwróconej w nagłówku Content-MD5 , która jest obliczana z żądanego zakresu. |
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. Jeśli plik jest niezaszyfrowany lub jeśli zaszyfrowane są tylko części metadanych pliku/aplikacji, wartość jest ustawiona na falsewartość . |
x-ms-file-permission-key |
Klucz uprawnienia do pliku. |
x-ms-file-attributes |
Atrybuty systemu plików w pliku. Aby uzyskać więcej informacji, zobacz listę dostępnych atrybutów. |
x-ms-file-creation-time |
Wartość daty/godziny UTC reprezentująca właściwość godziny utworzenia pliku. |
x-ms-file-last-write-time |
Wartość daty/godziny UTC reprezentująca właściwość czasu ostatniego zapisu dla pliku. |
x-ms-file-change-time |
Data/godzina UTC, która reprezentuje właściwość zmiany godziny dla pliku. |
x-ms-file-file-id |
Identyfikator pliku. |
x-ms-file-parent-id |
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 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 znajduje się w żądaniu, nie jest obecny w odpowiedzi. |
Treść odpowiedzi
Treść odpowiedzi zawiera zawartość pliku.
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ę.
Uwagi
Wywołanie Get File w zakresie, który nie ma jeszcze zawartości lub które zostało wyczyszczone zwracane 0 dla tych bajtów.
Jeśli wywołasz wywołanie Get File bez określonego zakresu, usługa zwróci zakres bajtów do wartości określonej dla nagłówka x-ms-content-length . W przypadku wszystkich zakresów, które nie mają zawartości, usługa zwraca wartość 0 dla tych bajtów.
Get File Operacja może zostać ukończona przez dwie minuty na miB. Operacje, które średnio trwają dłużej niż dwie minuty na miB, upłynął limit czasu.