Get File
Mit dem Get File-Vorgang wird eine Datei einschließlich der zugehörigen Metadaten und Eigenschaften aus dem System gelesen oder heruntergeladen.
Protokollverfügbarkeit
| Aktiviertes Dateifreigabeprotokoll | Verfügbar |
|---|---|
| SMB |
|
| NFS |
|
Anforderung
Die Get File-Anforderung kann wie folgt erstellt werden. Es wird empfohlen, HTTPS zu verwenden.
| Methode | Anforderungs-URI | HTTP-Version |
|---|---|---|
GET |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile |
HTTP/1.1 |
Ersetzen Sie die Pfadkomponenten, die im Anforderungs-URI angezeigt werden, wie folgt durch Ihren eigenen:
| Pfadkomponente | BESCHREIBUNG |
|---|---|
myaccount |
Der Name Ihres Speicherkontos. |
myshare |
Der Name der Dateifreigabe. |
mydirectorypath |
Optional. Der Pfad zum Verzeichnis. |
myfile |
Der Name der Datei. |
Informationen zu Pfadbenennungseinschränkungen finden Sie unter Namens- und Verweisfreigaben, Verzeichnisse, Dateien und Metadaten.
URI-Parameter
Die folgenden zusätzlichen Parameter können für den Anforderungs-URI angegeben werden:
| Parameter | BESCHREIBUNG |
|---|---|
timeout |
Optional. Der timeout-Parameter wird in Sekunden angegeben. Weitere Informationen finden Sie unter Festlegen von Timeouts für Azure Files Vorgänge. |
Anforderungsheader
Die erforderlichen und optionalen Anforderungsheader werden in der folgenden Tabelle beschrieben:
| Anforderungsheader | BESCHREIBUNG |
|---|---|
Authorization |
Erforderlich. Gibt das Autorisierungsschema, den Kontonamen und die Signatur an. Weitere Informationen finden Sie unter Autorisieren von Anforderungen an Azure Storage. |
Date oder x-ms-date |
Erforderlich. Gibt die koordinierte Weltzeit (Coordinated Universal Time, UTC) für die Anforderung an. Weitere Informationen finden Sie unter Autorisieren von Anforderungen an Azure Storage. |
x-ms-version |
Erforderlich für alle autorisierten Anforderungen. Gibt die Version des für die Anforderung zu verwendenden Vorgangs an. Weitere Informationen finden Sie unter Versionsverwaltung für die Azure-Speicherdienste. |
Range |
Optional. Gibt Dateidaten nur aus dem angegebenen Bytebereich zurück. |
x-ms-range |
Optional. Gibt Dateidaten nur aus dem angegebenen Bytebereich zurück. Wenn Range und x-ms-range angegeben werden, verwendet der Dienst den Wert x-ms-range. Wenn keines angegeben ist, wird der gesamte Dateiinhalt zurückgegeben. Weitere Informationen finden Sie unter Angeben des Bereichsheaders für Azure Files Vorgänge. |
x-ms-range-get-content-md5: true |
Optional. Wenn dieser Header auf true festgelegt ist und zusammen mit dem Range Header angegeben wird, gibt der Dienst den MD5-Hash für den Bereich zurück, solange der Bereich kleiner oder gleich 4 Mebibytes (MiB) ist.Wenn der Header ohne den Range-Header angegeben wird, gibt der Dienst Statuscode 400 zurück (Ungültige Anforderung).Wenn dieser Header auf true festgelegt ist, wenn der Bereich die Größe von 4 MiB überschreitet, gibt der Dienst status Code 400 (Ungültige Anforderung) zurück. |
x-ms-lease-id:<ID> |
Optional. Version 2019-02-02 und höher. Wenn der Header angegeben ist, wird der Vorgang nur ausgeführt, wenn die Lease der Datei derzeit aktiv ist und die in der Anforderung angegebene Lease-ID mit der Lease-ID der Datei übereinstimmt. Andernfalls schlägt der Vorgang mit status Code 412 (Vorbedingung fehlgeschlagen) fehl. |
x-ms-client-request-id |
Optional. Stellt einen vom Client generierten, undurchsichtigen Wert mit einem Zeichenlimit von 1 Kibibyte (KiB) bereit, der bei der Konfiguration der Protokollierung in den Protokollen aufgezeichnet wird. Es wird dringend empfohlen, diesen Header zu verwenden, um clientseitige Aktivitäten mit Anforderungen zu korrelieren, die der Server empfängt. Weitere Informationen finden Sie unter Überwachen Azure Files. |
x-ms-file-request-intent |
Erforderlich, wenn Authorization der Header ein OAuth-Token angibt. Zulässiger Wert ist backup. Dieser Header gibt an, dass oder Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/actionMicrosoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action gewährt werden soll, wenn sie in der RBAC-Richtlinie enthalten sind, die der Identität zugewiesen ist, die mithilfe des Authorization Headers autorisiert ist. Verfügbar für Version 2022-11-02 und höher. |
x-ms-allow-trailing-dot: { <Boolean> } |
Optional. Version 2022-11-02 und höher. Der boolesche Wert gibt an, ob ein in der Anforderungs-URL vorhandener nachgestellter Punkt gekürzt werden soll oder nicht. Weitere Informationen finden Sie unter Benennen und Verweisen auf Freigaben, Verzeichnisse, Dateien und Metadaten. |
Anforderungstext
Keine.
Antwort
Die Antwort enthält einen HTTP-Statuscode, eine Gruppe von Antwortheadern und den Antworttext, der den Inhalt der Datei enthält.
Statuscode
Bei einem erfolgreichen Vorgang wird der Statuscode 200 (OK) zurückgegeben.
Informationen zu status Codes finden Sie unter Status- und Fehlercodes.
Antwortheader
Die Antwort für diesen Vorgang umfasst die folgenden Header. Die Antwort kann auch zusätzliche HTTP-Standardheader enthalten. Alle Standardheader entsprechen der HTTP/1.1-Protokollspezifikation.
| Antwortheader | BESCHREIBUNG |
|---|---|
Last-Modified |
Gibt das Datum und die Uhrzeit der letzten Änderung der Datei zurück. Das Datumsformat entspricht RFC 1123. Weitere Informationen finden Sie unter Darstellen von Datums-/Uhrzeitwerten in Headern. Jeder Vorgang, der die Datei oder ihre Eigenschaften ändert, aktualisiert den Zeitpunkt der letzten Änderung. |
x-ms-meta-name:value |
Ein Satz von Name-Wert-Paaren, die dieser Datei als benutzerdefinierte Metadaten zugeordnet sind. |
Content-Length |
Die Anzahl der im Antworttext vorhandenen Bytes. |
Content-Type |
Der für die Datei angegebene Inhaltstyp. Der Standardinhaltstyp ist application/octet-stream. |
Content-Range |
Der Bytesbereich, der zurückgegeben wird, wenn der Client durch Festlegen Range des Anforderungsheaders eine Teilmenge der Datei angefordert hat. |
ETag |
Enthält einen Wert, den Sie verwenden können, um Vorgänge bedingt auszuführen. Der Wert wird in Anführungszeichen eingeschlossen. |
Content-MD5 |
Wenn die Datei über einen MD5-Hash verfügt und bei der Anforderung die vollständige Datei gelesen werden soll, wird dieser Antwortheader zurückgegeben, sodass der Client die Integrität des Nachrichteninhalts überprüfen kann. Wenn die Anforderung einen angegebenen Bereich lesen soll und auf x-ms-range-get-content-md5 festgelegt trueist, gibt die Anforderung einen MD5-Hash für den Bereich zurück, solange die Bereichsgröße kleiner oder gleich 4 MiB ist.Wenn keine dieser Bedingungssätze ist, wird truekein Wert für den Content-MD5 Header zurückgegeben.Wenn x-ms-range-get-content-md5 ohne den Bereichsheader angegeben wird, gibt der Dienst status Code 400 (Ungültige Anforderung) zurück.Wenn x-ms-range-get-content-md5 auf true festgelegt ist, wenn der Bereich 4 MiB überschreitet, gibt der Dienst status Code 400 (Ungültige Anforderung) zurück. |
Content-Encoding |
Gibt den Wert zurück, der für den Anforderungsheader Content-Encoding angegeben wurde. |
Content-Language |
Gibt den Wert zurück, der für den Anforderungsheader Content-Language angegeben wurde. |
Cache-Control |
Wird zurückgegeben, wenn sie zuvor für die Datei angegeben wurde. |
Content-Disposition |
Gibt den Wert zurück, der für den x-ms-content-disposition-Header angegeben worden war, und legt fest, wie die Antwort verarbeitet werden soll.Das Content-Disposition Antwortheaderfeld vermittelt zusätzliche Informationen zur Verarbeitung der Antwortnutzlast und kann auch zum Anfügen zusätzlicher Metadaten verwendet werden. Wenn sie beispielsweise auf attachmentfestgelegt ist, Content-Disposition gibt an, dass der Benutzer-Agent die Antwort nicht anzeigen soll, sondern stattdessen ein Fenster "Speichern unter" anzeigen sollte. |
x-ms-request-id |
Identifiziert eindeutig die Anforderung, die gestellt wurde, und kann zur Problembehandlung für die Anforderung verwendet werden. Weitere Informationen finden Sie unter Problembehandlung bei API-Vorgängen. |
x-ms-version |
Die Dienstversion, die zum Ausführen der Anforderung verwendet wurde. |
Accept-Ranges: bytes |
Gibt an, dass der Dienst Anforderungen für partielle Dateiinhalte unterstützt. |
Date |
Date |
x-ms-copy-completion-time:<datetime> |
Version 2015-02-21 und höher. Die Abschlusszeit des letzten versuchten Kopierdateivorgangs , bei dem diese Datei die Zieldatei war. Dieser Wert kann die Zeit eines abgeschlossenen, abgebrochenen oder fehlgeschlagenen Kopierversuchs angeben. Dieser Header wird nicht angezeigt, wenn eine Kopie aussteht, wenn diese Datei noch nie das Ziel eines Kopiervorgangs war oder wenn diese Datei nach einem abgeschlossenen Kopiervorgang geändert wurde, bei dem Dateieigenschaften festlegen oder Datei erstellen verwendet wurde. |
x-ms-copy-status-description: <error string> |
Version 2015-02-21 und höher. Wird nur angezeigt, wenn x-ms-copy-statusein Fehler aufgetreten ist oder aussteht. Beschreibt die Ursache eines schwerwiegenden oder nicht tödlichen Kopiervorgangsfehlers. Dieser Header wird nicht angezeigt, wenn diese Datei noch nie das Ziel in einem Kopiervorgang war oder wenn diese Datei nach einem abgeschlossenen Kopiervorgang geändert wurde, bei dem Dateieigenschaften festlegen oder Datei erstellen verwendet wurde. |
x-ms-copy-id: <id> |
Version 2015-02-21 und höher. Der Zeichenfolgenbezeichner für den letzten versuchten Kopierdateivorgang , bei dem diese Datei die Zieldatei war. Dieser Header wird nicht angezeigt, wenn die Datei nie das Ziel eines Kopiervorgangs war oder wenn diese Datei nach einem abgeschlossenen Kopiervorgang geändert wurde, bei dem Dateieigenschaften festlegen oder Datei erstellen verwendet wurde. |
x-ms-copy-progress: <bytes copied/bytes total> |
Version 2015-02-21 und höher. Enthält die Anzahl der Bytes, die kopiert wurden, und die Gesamtbytes in der Quelle im letzten versuchten Kopierdateivorgang , bei dem diese Datei die Zieldatei war. Kann von 0 bis zur Anzahl der kopierten Content-Length Bytes angezeigt werden. Dieser Header wird nicht angezeigt, wenn diese Datei noch nie das Ziel in einem Kopiervorgang war oder wenn diese Datei nach einem abgeschlossenen Kopiervorgang geändert wurde, bei dem Dateieigenschaften festlegen oder Datei erstellen verwendet wurde. |
x-ms-copy-source: url |
Version 2015-02-21 und höher. Eine URL mit einer Länge von bis zu 2 KB, die die Quelldatei angibt, die beim letzten versuchten Kopiervorgang verwendet wurde, wobei diese Datei die Zieldatei war. Dieser Header wird nicht angezeigt, wenn diese Datei noch nie das Ziel in einem Kopiervorgang war oder wenn diese Datei nach einem abgeschlossenen Kopiervorgang geändert wurde, bei dem Dateieigenschaften festlegen oder Datei erstellen verwendet wurde. |
x-ms-copy-status: <pending ¦ success ¦ aborted ¦ failed> |
Version 2015-02-21 und höher. Der Zustand des Kopiervorgangs, der von identifiziert wird x-ms-copy-id, mit den folgenden Werten:- pending: Der Kopiervorgang wird ausgeführt. Überprüfen Sie x-ms-copy-status-description , ob zeitweilige, nicht schwerwiegende Fehler den Kopierfortschritt behindern, aber keinen Fehler verursachen.- success: Der Kopiervorgang wurde erfolgreich abgeschlossen.- aborted: Der Kopiervorgang wurde durch Abbruch der Kopierdatei beendet.- failed: Fehler beim Kopieren. Fehlerdetails finden Sie in x-ms-copy-status-description.Dieser Header wird nicht angezeigt, wenn diese Datei noch nie das Ziel in einem Kopiervorgang war oder wenn diese Datei nach einem abgeschlossenen Vorgang zum Kopieren von Datei geändert wurde, bei dem Dateieigenschaften festlegen oder Datei erstellen verwendet wurde. |
x-ms-content-md5 |
Ab Version 2016-05-31 wird dieser Antwortheader mit dem Wert des MD5-Werts der gesamten Datei zurückgegeben, wenn die Anforderung einen Bereichsheader (range oder x-ms-range) enthält. Dieser Wert kann gleich dem im Header zurückgegebenen Wert sein, der aus dem Content-MD5 angeforderten Bereich berechnet wird. |
x-ms-server-encrypted: true/false |
Version 2017-04-17 und höher. Der Wert dieses Headers wird auf true festgelegt, wenn die Dateidaten und Anwendungsmetadaten mit dem angegebenen Algorithmus vollständig verschlüsselt werden. Wenn die Datei unverschlüsselt ist oder nur Teile der Datei-/Anwendungsmetadaten verschlüsselt sind, wird der Wert auf falsefestgelegt. |
x-ms-file-permission-key |
Der Schlüssel der Berechtigung der Datei. |
x-ms-file-attributes |
Die Dateisystemattribute für die Datei. Weitere Informationen finden Sie in der Liste der verfügbaren Attribute. |
x-ms-file-creation-time |
Der UTC-Datums-/Uhrzeitwert, der die Erstellungszeiteigenschaft für die Datei darstellt. |
x-ms-file-last-write-time |
Der UTC-Datums-/Uhrzeitwert, der die Eigenschaft der letzten Schreibzeit für die Datei darstellt. |
x-ms-file-change-time |
Datum/Uhrzeit des UTC-Werts, der die Änderungszeiteigenschaft für die Datei darstellt. |
x-ms-file-file-id |
Die Datei-ID der Datei. |
x-ms-file-parent-id |
Die übergeordnete Datei-ID der Datei. |
x-ms-lease-duration:infinite |
Version 2019-02-02 und höher. Wenn eine Datei geleast wird, gibt an, dass die Lease von unendlicher Dauer ist. |
x-ms-lease-state: <available, leased, broken> |
Version 2019-02-02 und höher. Wenn eine Datei geleast wird, gibt den Leasestatus der Datei an. |
x-ms-lease-status: <locked, unlocked> |
Version 2019-02-02 und höher. Wenn eine Datei geleast wird, gibt die Lease-status der Datei an. |
x-ms-client-request-id |
Kann verwendet werden, um Anforderungen und ihre entsprechenden Antworten zu behandeln. Der Wert dieses Headers ist gleich dem Wert des x-ms-client-request-id Headers, wenn er in der Anforderung vorhanden ist und der Wert nicht mehr als 1.024 sichtbare ASCII-Zeichen enthält. Wenn der x-ms-client-request-id Header in der Anforderung nicht vorhanden ist, ist er in der Antwort nicht vorhanden. |
Antworttext
Der Antworttext enthält den Inhalt der Datei.
Beispiel für eine Antwort
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
Autorisierung
Dieser Vorgang kann nur vom Kontobesitzer aufgerufen werden.
Hinweise
Das Aufrufen Get File eines Bereichs, der noch keinen Inhalt enthält oder der gelöscht wurde, gibt für diese Bytes zurück 0 .
Wenn Sie ohne angegebenen Bereich aufrufen Get File , gibt der Dienst den Bytesbereich bis zum Wert zurück, der für den x-ms-content-length Header angegeben ist. Für alle Bereiche, in denen Inhalte fehlen, gibt der Dienst für diese Bytes zurück 0 .
Ein Get File Vorgang darf zwei Minuten pro MiB abgeschlossen werden. Vorgänge, die im Durchschnitt länger als zwei Minuten pro MiB dauern, führen zu einem Timeout.