Hämta fil
Åtgärden Get File läser eller laddar ned en fil från systemet, inklusive dess metadata och egenskaper.
Protokolltillgänglighet
| Aktiverat filresursprotokoll | Tillgängligt |
|---|---|
| SMB |
|
| NFS |
|
Förfrågan
Begäran Get File kan konstrueras på följande sätt. Vi rekommenderar att du använder HTTPS.
| Metod | URI för förfrågan | HTTP-version |
|---|---|---|
GET |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile |
HTTP/1.1 |
Ersätt sökvägskomponenterna som visas i begärande-URI:n med dina egna, enligt följande:
| Sökvägskomponent | Description |
|---|---|
myaccount |
Namnet på ditt lagringskonto. |
myshare |
Namnet på filresursen. |
mydirectorypath |
Valfritt. Sökvägen till katalogen. |
myfile |
Namnet på filen. |
Information om namngivningsbegränsningar för sökväg finns i Namn och referensresurser, kataloger, filer och metadata.
URI-parametrar
Följande ytterligare parametrar kan anges i begärande-URI:n:
| Parameter | Beskrivning |
|---|---|
timeout |
Valfritt. Parametern timeout uttrycks i sekunder. Mer information finns i Ange tidsgränser för Azure Files åtgärder. |
Begärandehuvuden
De obligatoriska och valfria begäranderubrikerna beskrivs i följande tabell:
| Begärandehuvud | Beskrivning |
|---|---|
Authorization |
Krävs. Anger auktoriseringsschema, kontonamn och signatur. Mer information finns i Auktorisera begäranden till Azure Storage. |
Date eller x-ms-date |
Krävs. Anger Coordinated Universal Time (UTC) för begäran. Mer information finns i Auktorisera begäranden till Azure Storage. |
x-ms-version |
Krävs för alla auktoriserade begäranden. Anger vilken version av åtgärden som ska användas för den här begäran. Mer information finns i Versionshantering för Azure Storage-tjänsterna. |
Range |
Valfritt. Returnerar endast fildata från det angivna byteintervallet. |
x-ms-range |
Valfritt. Returnerar endast fildata från det angivna byteintervallet. Om både Range och x-ms-range anges använder tjänsten värdet x-ms-range. Om inget av dem anges returneras hela filinnehållet. Mer information finns i Ange områdesrubriken för Azure Files åtgärder. |
x-ms-range-get-content-md5: true |
Valfritt. När det här huvudet är inställt på true och det anges tillsammans med huvudet returnerar tjänsten MD5-hashen för intervallet, så länge intervallet är mindre än eller lika med Range 4 mebibyte (MiB) i storlek.Om det här huvudet anges utan Range huvudet returnerar tjänsten statuskoden 400 (felaktig begäran).Om det här huvudet anges till true när intervallet överskrider 4 MiB i storlek returnerar tjänsten statuskoden 400 (felaktig begäran). |
x-ms-lease-id:<ID> |
Valfritt. Version 2019-02-02 och senare. Om rubriken anges utförs åtgärden endast om filens lån för närvarande är aktivt och låne-ID:t som anges i begäran matchar filens låne-ID. Annars misslyckas åtgärden med statuskoden 412 (förhandsvillkoret misslyckades). |
x-ms-client-request-id |
Valfritt. Tillhandahåller ett klientgenererat, täckande värde med en teckengräns på 1 kibibyte (KiB) som registreras i loggarna när loggningen har konfigurerats. Vi rekommenderar starkt att du använder det här huvudet för att korrelera aktiviteter på klientsidan med begäranden som servern tar emot. Mer information finns i Övervaka Azure Files. |
x-ms-file-request-intent |
Krävs om Authorization huvudet anger en OAuth-token. Acceptabelt värde är backup. Det här huvudet anger att Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action eller Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action ska beviljas om de ingår i RBAC-principen som tilldelats den identitet som har behörighet med huvudet Authorization . Tillgänglig för version 2022-11-02 och senare. |
x-ms-allow-trailing-dot: { <Boolean> } |
Valfritt. Version 2022-11-02 och senare. Det booleska värdet anger om en avslutande punkt som finns i begärande-URL:en ska trimmas eller inte. Mer information finns i Namnge och referera till resurser, kataloger, filer och metadata. |
Begärandetext
Inga.
Svarsåtgärder
Svaret innehåller en HTTP-statuskod, en uppsättning svarshuvuden och svarstexten som innehåller innehållet i filen.
Statuskod
En lyckad åtgärd returnerar statuskoden 200 (OK).
Information om statuskoder finns i Status och Felkoder.
Svarshuvuden
Svaret för den här åtgärden innehåller följande rubriker. Svaret kan också innehålla ytterligare HTTP-standardhuvuden. Alla standardhuvuden överensstämmer med HTTP/1.1-protokollspecifikationen.
| Svarsrubrik | Description |
|---|---|
Last-Modified |
Returnerar datum och tid när filen senast ändrades. Datumformatet följer RFC 1123. Mer information finns i Representera datum/tid-värden i rubriker. Alla åtgärder som ändrar filen eller dess egenskaper uppdaterar den senaste ändringstiden. |
x-ms-meta-name:value |
En uppsättning namn/värde-par som är associerade med den här filen som användardefinierade metadata. |
Content-Length |
Antalet byte som finns i svarstexten. |
Content-Type |
Den innehållstyp som angetts för filen. Standardinnehållstypen är application/octet-stream. |
Content-Range |
Byteintervallet returnerades om klienten begärde en delmängd av filen genom att ange Range begärandehuvudet. |
ETag |
Innehåller ett värde som du kan använda för att utföra åtgärder villkorligt. Värdet omges av citattecken. |
Content-MD5 |
Om filen har en MD5-hash och begäran är att läsa hela filen returneras svarshuvudet så att klienten kan söka efter meddelandets innehållsintegritet. Om begäran ska läsa ett angivet intervall och x-ms-range-get-content-md5 är inställd på truereturnerar begäran en MD5-hash för intervallet, så länge intervallstorleken är mindre än eller lika med 4 MiB.Om ingen av dessa villkorsuppsättningar är truereturneras inget värde för Content-MD5 huvudet.Om x-ms-range-get-content-md5 anges utan intervallrubriken returnerar tjänsten statuskoden 400 (felaktig begäran).Om x-ms-range-get-content-md5 anges till true när intervallet överskrider 4 MiB returnerar tjänsten statuskoden 400 (felaktig begäran). |
Content-Encoding |
Returnerar värdet som angavs för begärandehuvudet Content-Encoding . |
Content-Language |
Returnerar värdet som angavs för begärandehuvudet Content-Language . |
Cache-Control |
Returneras om den tidigare har angetts för filen. |
Content-Disposition |
Returnerar det värde som angavs för x-ms-content-disposition huvudet och anger hur svaret ska bearbetas.Fältet Content-Disposition svarshuvud förmedlar ytterligare information om hur du bearbetar svarsnyttolasten, och det kan också användas för att bifoga ytterligare metadata. Om det till exempel är inställt på attachmentanger Content-Disposition det att användaragenten inte ska visa svaret utan i stället visa ett Spara som-fönster. |
x-ms-request-id |
Identifierar unikt den begäran som gjordes och kan användas för att felsöka begäran. Mer information finns i Felsöka API-åtgärder. |
x-ms-version |
Den tjänstversion som användes för att köra begäran. |
Accept-Ranges: bytes |
Anger att tjänsten stöder begäranden om partiellt filinnehåll. |
Date |
Date |
x-ms-copy-completion-time:<datetime> |
Version 2015-02-21 och senare. Sluttiden för den senaste kopieringsfilen där den här filen var målfilen. Det här värdet kan ange tidpunkten för ett slutfört, avbrutet eller misslyckat kopieringsförsök. Det här huvudet visas inte om en kopia väntar, om den här filen aldrig har varit målet i en kopieringsfilåtgärd eller om den här filen har ändrats efter en avslutad kopieringsfilåtgärd som använde Ange filegenskaper eller Skapa fil. |
x-ms-copy-status-description: <error string> |
Version 2015-02-21 och senare. Visas bara när x-ms-copy-statusmisslyckas eller väntar. Beskriver orsaken till ett allvarligt eller icke-dödligt kopieringsfel. Det här huvudet visas inte om den här filen aldrig har varit målet i en kopieringsfilåtgärd , eller om den här filen har ändrats efter en avslutad kopieringsfilåtgärd som använde Ange filegenskaper eller Skapa fil. |
x-ms-copy-id: <id> |
Version 2015-02-21 och senare. Strängidentifieraren för den senaste kopieringsfilen där den här filen var målfilen. Det här huvudet visas inte om filen aldrig har varit målet i en kopieringsfilåtgärd , eller om den här filen har ändrats efter en avslutad kopieringsfilåtgärd som använde Ange filegenskaper eller Skapa fil. |
x-ms-copy-progress: <bytes copied/bytes total> |
Version 2015-02-21 och senare. Innehåller antalet byte som kopierades och det totala antalet byte i källan i den senaste kopieringsfilåtgärden där den här filen var målfilen. Kan visa från 0 till antalet kopierade Content-Length byte. Det här huvudet visas inte om den här filen aldrig har varit målet i en kopieringsfilåtgärd , eller om den här filen har ändrats efter en avslutad kopieringsfilåtgärd som använde Ange filegenskaper eller Skapa fil. |
x-ms-copy-source: url |
Version 2015-02-21 och senare. En URL på upp till 2 kB som anger den källfil som användes i den senaste kopieringsfilen där den här filen var målfilen. Det här huvudet visas inte om den här filen aldrig har varit målet i en kopieringsfilåtgärd eller om den här filen har ändrats efter en avslutad kopieringsfilåtgärd som använde Ange filegenskaper eller Skapa fil. |
x-ms-copy-status: <pending ¦ success ¦ aborted ¦ failed> |
Version 2015-02-21 och senare. Tillståndet för kopieringsåtgärden som identifieras av x-ms-copy-id, med följande värden:- pending: Kopiering pågår. Kontrollera x-ms-copy-status-description om tillfälliga, icke-allvarliga fel hindrar kopieringsförloppet men inte orsakar fel.- success: Kopian har slutförts.- aborted: Kopiering avslutades av Avbryt kopieringsfil.- failed: Kopiering misslyckades. Se x-ms-copy-status-description för felinformation.Det här huvudet visas inte om den här filen aldrig har varit målet i en kopieringsfilåtgärd , eller om den här filen har ändrats efter en slutförd kopieringsfilåtgärd som använde Ange filegenskaper eller Skapa fil. |
x-ms-content-md5 |
Från och med version 2016-05-31, om filen har en MD5-hash, och om begäran innehåller ett intervallhuvud (range eller x-ms-range), returneras det här svarshuvudet med värdet för hela filens MD5-värde. Det här värdet kan vara lika med det värde som returneras i Content-MD5 huvudet, som beräknas från det begärda intervallet. |
x-ms-server-encrypted: true/false |
Version 2017-04-17 och senare. Värdet för det här huvudet anges till true om fildata och programmetadata är helt krypterade med hjälp av den angivna algoritmen. Om filen är okrypterad, eller om endast delar av fil-/programmetadata krypteras, anges värdet till false. |
x-ms-file-permission-key |
Nyckeln för filens behörighet. |
x-ms-file-attributes |
Filsystemattributen i filen. Mer information finns i listan över tillgängliga attribut. |
x-ms-file-creation-time |
UTC-datum/tid-värdet som representerar egenskapen för att skapa tid för filen. |
x-ms-file-last-write-time |
UTC-datum/tid-värdet som representerar den senaste skrivtidsegenskapen för filen. |
x-ms-file-change-time |
UTC-datum/tid som representerar egenskapen för ändringstid för filen. |
x-ms-file-file-id |
Filens fil-ID. |
x-ms-file-parent-id |
Det överordnade fil-ID:t för filen. |
x-ms-lease-duration:infinite |
Version 2019-02-02 och senare. När en fil leasas anger att lånet är av oändlig varaktighet. |
x-ms-lease-state: <available, leased, broken> |
Version 2019-02-02 och senare. När en fil hyrs anger du lånetillståndet för filen. |
x-ms-lease-status: <locked, unlocked> |
Version 2019-02-02 och senare. När en fil leasas anger du lånestatus för filen. |
x-ms-client-request-id |
Kan användas för att felsöka begäranden och deras motsvarande svar. Värdet för det här huvudet är lika med värdet x-ms-client-request-id för huvudet om det finns i begäran och värdet inte innehåller fler än 1 024 synliga ASCII-tecken.
x-ms-client-request-id Om rubriken inte finns i begäran finns den inte i svaret. |
Själva svaret
Svarstexten innehåller innehållet i filen.
Exempelsvar
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
Auktorisering
Endast kontoägaren kan anropa den här åtgärden.
Kommentarer
Anropar Get File över ett intervall som ännu inte har innehåll eller som har rensats returnerar 0 för dessa byte.
Om du anropar Get File utan angivet intervall returnerar tjänsten byteintervallet upp till det värde som har angetts för x-ms-content-length huvudet. För alla intervall som saknar innehåll returnerar 0 tjänsten för dessa byte.
En Get File åtgärd tillåts att två minuter per MiB slutförs. Åtgärder som tar längre tid än två minuter per MiB i genomsnitt kommer att överskrida tidsgränsen.