Freigeben über

Path - List

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

Listet Pfade und deren Eigenschaften im angegebenen 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

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 Bindestriche sind nicht zulässig. Alle Buchstaben müssen Kleinbuchstaben sein. Der Wert muss zwischen 3 und 63 Zeichen lang sein.

RegEx-Muster: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$
recursive
 query True

boolean

Bei "true" werden alle Pfade aufgelistet. Andernfalls werden nur Pfade im Stammverzeichnis des Dateisystems aufgeführt. Wenn "verzeichnis" angegeben ist, enthält die Liste nur Pfade, die denselben Stamm verwenden.
resource
 query True

FilesystemResourceType

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

string

Die Anzahl der bei jedem Aufruf zurückgegebenen Pfade ist begrenzt. Wenn die Anzahl der zurückzugebenden Pfade diesen Grenzwert überschreitet, wird im Antwortheader x-ms-continuation ein Fortsetzungstoken zurückgegeben. Wenn in der Antwort ein Fortsetzungstoken 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 URL-codiert sein muss, bevor es in einem nachfolgenden Aufruf verwendet wird.
directory
 query

string

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

integer

int32

Ein optionaler Wert, der die maximale Anzahl von Elementen angibt, die zurückgegeben werden sollen. Wenn nicht angegeben oder größer als 5.000, enthält die Antwort bis zu 5.000 Elemente.
timeout
 query

integer

int32

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

boolean

Optional. Nur gültig, wenn der hierarchische Namespace für das Konto aktiviert ist. Bei "true" werden die in den Besitzer- und Gruppenfeldern jedes Listeneintrags zurückgegebenen Benutzeridentitätswerte von Azure Active Directory-Objekt-IDs in Benutzerprinzipalnamen transformiert. Bei "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 haben.

Anforderungsheader

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

string

Eine in den Analyseprotokollen für die Problembehandlung und Korrelation aufgezeichnete UUID.

RegEx-Muster: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
x-ms-date

string

Gibt die koordinierte Weltzeit (Coordinated Universal Time, UTC) für die Anforderung an. Dies ist erforderlich, wenn die Autorisierung mit gemeinsam genutzten Schlüsseln verwendet wird.
x-ms-version

string

Gibt die Version des REST-Protokolls an, das für die Verarbeitung der Anforderung verwendet wird. Dies ist erforderlich, wenn die Autorisierung mit gemeinsam genutzten Schlüsseln verwendet wird.

Antworten

Name Typ Beschreibung
200 OK

PathList

OK,

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 Bad Request, ContentLengthMustBeZero, "Der Content-Length-Anforderungsheader muss null sein."
  • 400 Bad Request, InvalidAuthenticationInfo, "Authentifizierungsinformationen werden nicht im richtigen Format angegeben. Überprüfen Sie den Wert des Autorisierungsheaders."
  • 400 Bad Request, 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 Bad Request, InvalidHeaderValue, "Der Wert für einen der HTTP-Header hat nicht das richtige Format."
  • 400 Bad Request, InvalidHttpVerb, "The HTTP verb specified is invalid - it is not recognized by the server."
  • 400 Bad Request, InvalidInput, "Eine der Anforderungseingaben ist ungültig."
  • 400 Bad Request, InvalidPropertyName, "Ein Eigenschaftsname darf nicht leer sein."
  • 400 Bad Request, InvalidPropertyName, "Der Eigenschaftenname enthält ungültige Zeichen."
  • 400 Bad Request, InvalidQueryParameterValue, "Value for one of the query parameters specified in the request URI is invalid."
  • 400 Bad Request, 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 Bad Request, MissingRequiredHeader, "Ein HTTP-Header, der für diese Anforderung erforderlich ist, ist nicht angegeben."
  • 400 Bad Request, MissingRequiredQueryParameter, "Ein Abfrageparameter, der für diese Anforderung erforderlich ist, ist nicht angegeben."
  • 400 Bad Request, MultipleConditionHeadersNotSupported, "Mehrere Bedingungsheader werden nicht unterstützt."
  • 400 Bad Request, OutOfRangeInput, "Eine der Anforderungseingaben liegt außerhalb des Bereichs."
  • 400 Bad Request, OutOfRangeQueryParameterValue, "Einer der im Anforderungs-URI angegebenen Abfrageparameter liegt außerhalb des zulässigen Bereichs."
  • 400 Bad Request, UnsupportedHeader, "Einer der in der Anforderung angegebenen Header wird nicht unterstützt."
  • 400 Bad Request, UnsupportedQueryParameter, "Einer der Abfrageparameter, die im Anforderungs-URI angegeben sind, wird nicht unterstützt."
  • 400 Bad Request, UnsupportedRestVersion, "The specified Rest Version is Unsupported."
  • 403 Verboten, AccountIsDisabled, "Das angegebene Konto ist deaktiviert."
  • 403 Forbidden, AuthorizationFailure, "This request is not authorized to perform this operation."
  • 403 Forbidden, InsufficientAccountPermissions, "Das Konto, auf das zugegriffen wird, verfügt nicht über ausreichende Berechtigungen, um diesen Vorgang auszuführen."
  • 404 Not Found, FilesystemNotFound, "Das angegebene Dateisystem ist nicht vorhanden."
  • 404 Nicht gefunden, PathNotFound, "Der angegebene Pfad ist nicht vorhanden."
  • 404 Not Found, RenameDestinationParentPathNotFound, "Das übergeordnete Verzeichnis des Zielpfads ist nicht vorhanden."
  • 404 Nicht gefunden, ResourceNotFound, "Die angegebene Ressource ist nicht vorhanden."
  • 404 Not Found, SourcePathNotFound, "Der Quellpfad für einen Umbenennungsvorgang ist nicht vorhanden."
  • 405 Method Not Allowed, UnsupportedHttpVerb, "The resource does't support the specified HTTP verb."
  • 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, "Der angegebene Pfad oder ein Element des Pfads ist vorhanden, und sein Ressourcentyp ist für diesen Vorgang ungültig." * 409 Conflict, InvalidFlushOperation, "Die Ressource wurde von der Blobdienst-API erstellt oder geändert und kann nicht von der Data Lake Storage-Dienst-API geschrieben werden."
  • 409 Conflict, InvalidRenameSourcePath, "Das Quellverzeichnis kann nicht mit dem Zielverzeichnis identisch sein, noch kann das Ziel ein Unterverzeichnis des Quellverzeichnisses sein."
  • 409 Conflict, InvalidSourceOrDestinationResourceType, "Quell- und Zielressourcentyp müssen identisch sein."
  • 409 Conflict, LeaseAlreadyPresent, "Es ist bereits ein Lease vorhanden."
  • 409 Conflict, LeaseIdMismatchWithLeaseOperation, "Die angegebene Lease-ID stimmte nicht mit der Lease-ID für die Ressource mit dem angegebenen Leasevorgang überein."
  • 409 Conflict, LeaseIsAlreadyBroken, "Die Lease wurde bereits gebrochen und kann nicht erneut gebrochen werden."
  • 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, "Die Lease-ID stimmt überein, aber die Lease befindet sich derzeit im Unterbrechungszustand und kann erst erworben werden, wenn sie unterbrochen ist."
  • 409 Conflict, LeaseIsBreakingAndCannotBeChanged, "The lease ID matched, but the lease is currently in breaking state and cannot be change."
  • 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, "Die Lease-ID wurde übereinstimmend, aber die Lease wurde explizit gebrochen und kann nicht verlängert werden."
  • 409 Conflict, LeaseNameMismatch, "Der angegebene Leasename stimmte nicht mit dem vorhandenen Leasenamen überein."
  • 409 Conflict, LeaseNotPresentWithLeaseOperation, "Die Lease-ID ist beim angegebenen Leasevorgang nicht vorhanden."
  • 409 Conflict, PathAlreadyExists, "Der angegebene Pfad ist bereits vorhanden."
  • 409 Conflict, PathConflict, "Der angegebene Pfad oder ein Element des Pfads ist vorhanden, und sein Ressourcentyp ist für diesen Vorgang ungültig."
  • 409 Conflict, SourcePathIsBeingDeleted, "The specified source path is marked to be deleted."
  • 409 Conflict, ResourceTypeMismatch, "The resource type specified in the request does not match the type of the resource."
  • 412 Condition Failed, ConditionNotMet, "The condition specified using HTTP conditional header(s) is not met."
  • 412 Vorbedingung fehlgeschlagen, LeaseIdMismatch, "Die angegebene Lease-ID stimmte nicht mit der Lease-ID für die Ressource überein."
  • 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, "Derzeit ist keine Lease für die Ressource vorhanden."
  • 412 Vorbedingung fehlgeschlagen, LeaseLost, "Eine Lease-ID wurde angegeben, aber die Lease für die Ressource ist abgelaufen."
  • 412 Condition Failed, SourceConditionNotMet, "The source condition specified using HTTP conditional header(s) is not met."
  • 413 Anforderungsentität zu groß, RequestBodyTooLarge, "Der Anforderungstext ist zu groß und überschreitet den maximal zulässigen Grenzwert."
  • 416 Angeforderter Bereich nicht zufriedenstellend, 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, "Ausgehender Datenverkehr liegt über dem Kontolimit".
  • 503 Dienst nicht verfügbar, ServerBusy, "Eingehender Datenverkehr überschreitet das Kontolimit".
  • 503 Dienst nicht verfügbar, ServerBusy, "Vorgänge pro Sekunde überschreiten das Kontolimit."
  • 503 Dienst nicht verfügbar, ServerBusy: "Der Server kann derzeit keine Anforderungen empfangen. Please retry your request. (Wiederholen Sie die Anforderung.)“

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 "dateisystem" sein.
Path
PathList

DataLakeStorageError

Name Typ Beschreibung
error

Error

Das Dienstfehlerantwortobjekt.

Error

Das Dienstfehlerantwortobjekt.

Name Typ Beschreibung
code

string

Der Dienstfehlercode.
message

string

Die Dienstfehlermeldung.

FilesystemResourceType

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

Name Typ Beschreibung
filesystem

string

Path

Name Typ Standardwert Beschreibung
contentLength

integer

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 ist, 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 zurück, 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 mithilfe des Verschlüsselungsbereichs erfolgreich verschlüsselt wurde.
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 wurde.

PathList

Name Typ Beschreibung
paths

Path[]