Freigeben über

Path - List

  • Referenz
Dienst:
Storage Services
API-Version:
2023-08-03

Listet Pfade und deren Eigenschaften in einem bestimmten Dateisystem auf.

GET https://{accountName}.{dnsSuffix}/{filesystem}?recursive={recursive}&resource=filesystem
Mit optionalen Parametern: 
GET https://{accountName}.{dnsSuffix}/{filesystem}?directory={directory}&recursive={recursive}&continuation={continuation}&maxResults={maxResults}&upn={upn}&resource=filesystem&timeout={timeout}

URI-Parameter

Name In Erforderlich Typ Beschreibung
accountName
 path True

string

Der Name des Azure Storage-Kontos.
dnsSuffix
 path True

string

Das DNS-Suffix für den Azure Data Lake Storage-Endpunkt.
filesystem
 path True

string

minLength: 3
maxLength: 63
pattern: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$

Der Dateisystembezeichner. Der Wert muss mit einem Buchstaben oder einer Zahl beginnen und enden und darf nur Buchstaben, Zahlen und das Bindestrichzeichen (-) enthalten. Aufeinander folgende Striche sind nicht zulässig. Alle Buchstaben müssen Kleinbuchstaben sein. Der Wert muss zwischen 3 und 63 Zeichen enthalten.
recursive
 query True

boolean

Wenn "true", werden alle Pfade aufgelistet; andernfalls werden nur Pfade im Stammverzeichnis des Dateisystems aufgelistet. Wenn "directory" angegeben ist, enthält die Liste nur Pfade, die denselben Stamm aufweisen.
resource
 query True

FilesystemResourceType

Der Wert muss für alle Dateisystemvorgänge "Filesystem" sein.
continuation
 query

string

Die Anzahl der mit jedem Aufruf zurückgegebenen Pfade ist begrenzt. Wenn die Anzahl der zurückgegebenen Pfade diesen Grenzwert überschreitet, wird ein Fortsetzungstoken im Antwortheader "x-ms-continuation" zurückgegeben. Wenn ein Fortsetzungstoken in der Antwort zurückgegeben wird, muss es in einem nachfolgenden Aufruf des Listenvorgangs angegeben werden, um die Auflistung der Pfade fortzusetzen. Beachten Sie, dass das im Antwortheader "x-ms-continuation" zurückgegebene Fortsetzungstoken urlcodiert sein muss, bevor es in einem nachfolgenden Aufruf verwendet wird.
directory
 query

string

Filtert Ergebnisse auf Pfade innerhalb des angegebenen Verzeichnisses. Wenn das Verzeichnis nicht vorhanden ist, tritt ein Fehler auf.
maxResults
 query

integer (int32)

minimum: 1

Ein optionaler Wert, der die maximale Anzahl der zurückzugebenden Elemente angibt. Wenn sie nicht angegeben oder größer als 5.000 sind, enthält die Antwort bis zu 5.000 Elemente.
timeout
 query

integer (int32)

minimum: 1

Ein optionaler Vorgangstimeoutwert in Sekunden. Der Zeitraum beginnt, wenn die Anforderung vom Dienst empfangen wird. Wenn der Timeoutwert vor Abschluss des Vorgangs verstrichen ist, schlägt der Vorgang fehl.
upn
 query

boolean

Wahlfrei. Nur gültig, wenn der hierarchische Namespace für das Konto aktiviert ist. Wenn "true", werden die im Besitzer- und Gruppenfeld jedes Listeneintrags zurückgegebenen Benutzeridentitätswerte von Azure Active Directory-Objekt-IDs in Benutzerprinzipalnamen transformiert. Wenn "false", werden die Werte als Azure Active Directory-Objekt-IDs zurückgegeben. Der Standardwert ist "false". Beachten Sie, dass Gruppen- und Anwendungsobjekt-IDs nicht übersetzt werden, da sie keine eindeutigen Anzeigenamen enthalten.

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-request-id

string

pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$

Eine in den Analyseprotokollen aufgezeichnete UUID zur Problembehandlung und Korrelation.
x-ms-date

string

Gibt die koordinierte Weltzeit (UTC) für die Anforderung an. Dies ist erforderlich, wenn Sie die Gemeinsame Schlüsselautorisierung verwenden.
x-ms-version

string

Gibt die Version des REST-Protokolls an, das für die Verarbeitung der Anforderung verwendet wird. Dies ist erforderlich, wenn Sie die Gemeinsame Schlüsselautorisierung verwenden.

Antworten

Name Typ Beschreibung
200 OK

PathList

Okay

Header

  • Date: string
  • ETag: string
  • Last-Modified: string
  • x-ms-request-id: string
  • x-ms-version: string
  • x-ms-continuation: string
  • x-ms-encryption-scope: string
Other Status Codes

DataLakeStorageError

Ein Fehler ist aufgetreten. Die möglichen HTTP-Status-, Code- und Nachrichtenzeichenfolgen sind unten aufgeführt:

  • 400 Ungültige Anforderung, ContentLengthMustBeZero, "Der Anforderungsheader der Inhaltslänge muss null sein."
  • 400 Ungültige Anforderung, InvalidAuthenticationInfo, "Authentifizierungsinformationen werden nicht im richtigen Format angegeben. Überprüfen Sie den Wert des Autorisierungsheaders."
  • 400 Ungültige Anforderung, InvalidFlushPosition, "Die hochgeladenen Daten sind nicht zusammenhängend, oder der Wert des Positionsabfrageparameters entspricht nicht der Länge der Datei nach dem Anfügen der hochgeladenen Daten."
  • 400 Ungültige Anforderung, InvalidHeaderValue, "Der Wert für einen der HTTP-Header ist nicht im richtigen Format."
  • 400 Ungültige Anforderung, InvalidHttpVerb, "Das angegebene HTTP-Verb ist ungültig - es wird vom Server nicht erkannt."
  • 400 Ungültige Anforderung, InvalidInput, "Eine der Anforderungseingaben ist ungültig."
  • 400 Ungültige Anforderung, InvalidPropertyName, "Ein Eigenschaftsname darf nicht leer sein."
  • 400 Ungültige Anforderung, InvalidPropertyName, "Der Eigenschaftenname enthält ungültige Zeichen."
  • 400 Ungültige Anforderung, InvalidQueryParameterValue, "Wert für einen der abfrageparameter, die im Anforderungs-URI angegeben sind, ist ungültig."
  • 400 Ungültige Anforderung, InvalidResourceName, "Der angegebene Ressourcenname enthält ungültige Zeichen.".
  • 400 Ungültige Anforderung, InvalidSourceUri, "Der Quell-URI ist ungültig.".
  • 400 Ungültige Anforderung, InvalidUri, "Der Anforderungs-URI ist ungültig.".
  • 400 Ungültige Anforderung, MissingRequiredHeader, "Ein HTTP-Header, der für diese Anforderung erforderlich ist, ist nicht angegeben."
  • 400 Ungültige Anforderung, MissingRequiredQueryParameter, "Ein Abfrageparameter, der für diese Anforderung erforderlich ist, wird nicht angegeben."
  • 400 Ungültige Anforderung, MultipleConditionHeadersNotSupported, "Mehrere Bedingungsheader werden nicht unterstützt."
  • 400 Ungültige Anforderung, OutOfRangeInput, "Eine der Anforderungseingaben ist außerhalb des Zulässigen."
  • 400 Ungültige Anforderung, OutOfRangeQueryParameterValue: "Einer der im Anforderungs-URI angegebenen Abfrageparameter liegt außerhalb des zulässigen Bereichs."
  • 400 Ungültige Anforderung, nicht unterstütztHeader: "Einer der in der Anforderung angegebenen Header wird nicht unterstützt."
  • 400 Ungültige Anforderung, nicht unterstütztQueryParameter: "Einer der abfrageparameter, die im Anforderungs-URI angegeben sind, wird nicht unterstützt."
  • 400 Ungültige Anforderung, nicht unterstütztRestVersion, "Die angegebene Restversion wird nicht unterstützt."
  • 403 Verboten, AccountIsDisabled, "Das angegebene Konto ist deaktiviert.".
  • 403 Verboten, AuthorizationFailure: "Diese Anforderung ist nicht berechtigt, diesen Vorgang auszuführen."
  • 403 Forbidden, InsufficientAccountPermissions, "Auf das Konto zugegriffen wird, verfügt nicht über ausreichende Berechtigungen, um diesen Vorgang auszuführen."
  • 404 Nicht gefunden, FilesystemNotFound, "Das angegebene Dateisystem ist nicht vorhanden.".
  • 404 Nicht gefunden, PathNotFound, "Der angegebene Pfad ist nicht vorhanden.".
  • 404 Nicht gefunden, RenameDestinationParentPathNotFound, "Das übergeordnete Verzeichnis des Zielpfads ist nicht vorhanden.".
  • 404 Nicht gefunden, ResourceNotFound, "Die angegebene Ressource ist nicht vorhanden.".
  • 404 Nicht gefunden, SourcePathNotFound, "Der Quellpfad für einen Umbenennungsvorgang ist nicht vorhanden.".
  • 405-Methode nicht zulässig, nicht unterstütztHttpVerb, "Die Ressource unterstützt das angegebene HTTP-Verb nicht."
  • 409 Conflict, DestinationPathIsBeingDeleted, "The specified destination path is marked to be deleted."
  • 409 Conflict, DirectoryNotEmpty, "Der rekursive Abfrageparameterwert muss true sein, um ein nicht leeres Verzeichnis zu löschen."
  • 409 Conflict, FilesystemAlreadyExists, "Das angegebene Dateisystem ist bereits vorhanden."
  • 409 Conflict, FilesystemBeingDeleted, "Das angegebene Dateisystem wird gelöscht."
  • 409 Conflict, InvalidDestinationPath, "The specified path, or an element of the path, exists and its resource type is invalid for this operation." * 409 Conflict, InvalidFlushOperation, "The resource was created or modified by the Blob Service API and cannot be written to the Data Lake Storage Service API."
  • 409 Conflict, InvalidRenameSourcePath, "Das Quellverzeichnis kann nicht mit dem Zielverzeichnis identisch sein, oder das Ziel kann ein Unterverzeichnis des Quellverzeichnisses sein."
  • 409 Conflict, InvalidSourceOrDestinationResourceType, "Der Quell- und Zielressourcentyp muss identisch sein."
  • 409 Conflict, LeaseAlreadyPresent, "Es ist bereits eine Lease vorhanden."
  • 409 Conflict, LeaseIdMismatchWithLeaseOperation, "The lease ID specified did not match the lease ID for the resource with the specified lease operation."
  • 409 Conflict, LeaseIsAlreadyBroken, "Die Lease wurde bereits beschädigt und kann nicht erneut beschädigt werden."
  • 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, "The lease ID matched, but the lease is currently in break state and cannot be acquired until it is broken."
  • 409 Conflict, LeaseIsBreakingAndCannotBeChanged, "The lease ID matched, but the lease is currently in break state and cannot be changed."
  • 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, "Die Lease-ID ist übereinstimmend, aber die Lease wurde explizit abgebrochen und kann nicht erneuert werden."
  • 409 Conflict, LeaseNameMismatch, "Der angegebene Leasename entspricht nicht dem vorhandenen Leasenamen.".
  • 409 Conflict, LeaseNotPresentWithLeaseOperation, "The lease ID is not present with the specified lease operation."
  • 409 Conflict, PathAlreadyExists, "Der angegebene Pfad ist bereits vorhanden."
  • 409 Conflict, PathConflict, "The specified path, or an element of the path, exists and its resource type is invalid for this operation."
  • 409 Conflict, SourcePathIsBeingDeleted, "The specified source path is marked to be deleted."
  • 409 Conflict, ResourceTypeMismatch, "Der in der Anforderung angegebene Ressourcentyp stimmt nicht mit dem Typ der Ressource überein."
  • 412 Vorbedingung fehlgeschlagen, ConditionNotMet, "Die mit HTTP-bedingten Header(n) angegebene Bedingung ist nicht erfüllt."
  • 412 Vorbedingung fehlgeschlagen, LeaseIdMismatch, "Die angegebene Lease-ID entspricht nicht der Lease-ID für die Ressource."
  • 412 Vorbedingung fehlgeschlagen, LeaseIdMissing: "Es gibt derzeit eine Lease für die Ressource, und in der Anforderung wurde keine Lease-ID angegeben."
  • 412 Vorbedingung fehlgeschlagen, LeaseNotPresent, "Es gibt derzeit keine Lease für die Ressource.".
  • 412 Vorbedingung fehlgeschlagen, LeaseLost, "Eine Lease-ID wurde angegeben, aber die Lease für die Ressource ist abgelaufen."
  • 412 Vorbedingung fehlgeschlagen, SourceConditionNotMet, "Die mit HTTP-bedingten Header(n) angegebene Quellbedingung ist nicht erfüllt."
  • 413 Request Entity Too Large, RequestBodyTooLarge, "Der Anforderungstext ist zu groß und überschreitet den maximal zulässigen Grenzwert."
  • 416 Angeforderter Bereich nicht satisfiable, InvalidRange, "Der angegebene Bereich ist für die aktuelle Größe der Ressource ungültig.".
  • 500 Interner Serverfehler, InternalError, "Der Server hat einen internen Fehler gefunden. Versuchen Sie die Anforderung erneut."
  • 500 Interner Serverfehler, OperationTimedOut, "Der Vorgang konnte nicht innerhalb der zulässigen Zeit abgeschlossen werden."
  • 503 Dienst nicht verfügbar, ServerBusy, "Der Ausgang liegt über dem Kontolimit.".
  • 503 Dienst nicht verfügbar, ServerBusy, "Ingress liegt über dem Kontolimit.".
  • 503 Dienst nicht verfügbar, ServerBusy, "Vorgänge pro Sekunde liegen über dem Kontolimit.".
  • 503 Dienst nicht verfügbar, ServerBusy: "Der Server kann derzeit keine Anforderungen empfangen. Versuchen Sie es bitte erneut."

Header

  • x-ms-request-id: string
  • x-ms-version: string

Definitionen

Name Beschreibung
DataLakeStorageError
Error

Das Dienstfehlerantwortobjekt.
FilesystemResourceType

Der Wert muss für alle Dateisystemvorgänge "Filesystem" sein.
Path
PathList

DataLakeStorageError

Objekt
Name Typ Beschreibung
error

Error

Das Dienstfehlerantwortobjekt.

Error

Objekt

Das Dienstfehlerantwortobjekt.

Name Typ Beschreibung
code

string

Der Dienstfehlercode.
message

string

Die Dienstfehlermeldung.

FilesystemResourceType

Enumeration

Der Wert muss für alle Dateisystemvorgänge "Filesystem" sein.

Wert Beschreibung
filesystem

Path

Objekt
Name Typ Standardwert Beschreibung
contentLength

integer (int64)

etag

string

group

string

isDirectory

boolean

False
lastModified

string

name

string

owner

string

permissions

string

x-ms-encryption-context

string

Wenn der Wert der Verschlüsselungskontexteigenschaft festgelegt wird, wird der festgelegte Wert zurückgegeben. Nur gültig, wenn der hierarchische Namespace für das Konto aktiviert ist.
x-ms-encryption-key-sha256

string

Der Server gibt den SHA256 des vom Kunden bereitgestellten Verschlüsselungsschlüssels an, um den im Vorgang verwendeten Schlüssel zu überprüfen.
x-ms-encryption-scope

string

Wenn die Anforderung einen Verschlüsselungsbereich verwendet hat, kann der Client sicherstellen, dass der Inhalt der Anforderung erfolgreich mit dem Verschlüsselungsbereich verschlüsselt wird.
x-ms-server-encrypted: true/false

boolean

Der Wert dieses Headers wird auf "true" festgelegt, wenn der Inhalt der Anforderung mit dem angegebenen Algorithmus erfolgreich verschlüsselt wird.

PathList

Objekt
Name Typ Beschreibung
paths

Path[]