Path - List

Service:

Storage Services

API-versie:

2023-08-03

Paden en hun eigenschappen in het opgegeven bestandssysteem weergeven.

GET https://{accountName}.{dnsSuffix}/{filesystem}?recursive={recursive}&resource=filesystem

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
accountName	path	True	string	De naam van het Azure Storage-account.
dnsSuffix	path	True	string	Het DNS-achtervoegsel voor het Azure Data Lake Storage-eindpunt.
filesystem	path	True	string	De bestandssysteem-id. De waarde moet beginnen en eindigen met een letter of cijfer en mag alleen letters, cijfers en het streepje (-) bevatten. Opeenvolgende streepjes zijn niet toegestaan. Alle letters moeten kleine letters zijn. De waarde moet tussen 3 en 63 tekens bevatten. Regex-patroon: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$
recursive	query	True	boolean	Indien "true", worden alle paden vermeld; Anders worden alleen paden in de hoofdmap van het bestandssysteem weergegeven. Als 'directory' is opgegeven, bevat de lijst alleen paden die dezelfde hoofdmap delen.
resource	query	True	FilesystemResourceType	De waarde moet 'bestandssysteem' zijn voor alle bestandssysteembewerkingen.
continuation	query		string	Het aantal paden dat bij elke aanroep wordt geretourneerd, is beperkt. Als het aantal paden dat moet worden geretourneerd deze limiet overschrijdt, wordt een vervolgtoken geretourneerd in de antwoordheader x-ms-continuation. Wanneer een vervolgtoken wordt geretourneerd in het antwoord, moet dit worden opgegeven in een volgende aanroep van de lijstbewerking om door te gaan met het weergeven van de paden. Houd er rekening mee dat het vervolgtoken dat wordt geretourneerd in de antwoordheader x-ms-continuation, URL-codering moet zijn voordat deze in een volgende aanroep wordt gebruikt.
directory	query		string	Hiermee filtert u resultaten op paden binnen de opgegeven map. Er treedt een fout op als de map niet bestaat.
maxResults	query		integer int32	Een optionele waarde die het maximum aantal items aangeeft dat moet worden geretourneerd. Als u dit weglaat of groter is dan 5.000, bevat het antwoord maximaal 5000 items.
timeout	query		integer int32	Een optionele time-outwaarde voor bewerkingen in seconden. De periode begint wanneer de aanvraag door de service wordt ontvangen. Als de time-outwaarde verstrijkt voordat de bewerking is voltooid, mislukt de bewerking.
upn	query		boolean	Optioneel. Alleen geldig wanneer hiërarchische naamruimte is ingeschakeld voor het account. Als 'true' wordt weergegeven, worden de waarden van de gebruikersidentiteit die worden geretourneerd in de velden eigenaar en groep van elke lijstvermelding, getransformeerd van Azure Active Directory-object-id's naar User Principal Names. Als 'false' wordt weergegeven, worden de waarden geretourneerd als Azure Active Directory-object-id's. De standaardwaarde is false. Houd er rekening mee dat groeps- en toepassingsobject-id's niet worden vertaald omdat ze geen unieke beschrijvende namen hebben.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string	Een UUID die is vastgelegd in de analyselogboeken voor probleemoplossing en correlatie. Regex-patroon: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
x-ms-date		string	Geef de Coordinated Universal Time (UTC) op voor de aanvraag. Dit is vereist bij het gebruik van autorisatie van gedeelde sleutels.
x-ms-version		string	Hiermee geeft u de versie van het REST-protocol op dat wordt gebruikt voor het verwerken van de aanvraag. Dit is vereist bij het gebruik van autorisatie van gedeelde sleutels.

Antwoorden

Name	Type	Description
200 OK	PathList	OK Kopteksten 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	Er is een fout opgetreden. De mogelijke HTTP-status, code en berichttekenreeksen worden hieronder vermeld: 400 Ongeldige aanvraag, ContentLengthMustBeZero, 'De aanvraagheader voor lengte van inhoud moet nul zijn'. 400 Ongeldige aanvraag, InvalidAuthenticationInfo, "Verificatiegegevens worden niet in de juiste indeling gegeven. Controleer de waarde van autorisatieheader.' 400 Ongeldige aanvraag, InvalidFlushPosition, "De geüploade gegevens zijn niet aaneengesloten of de waarde van de positiequeryparameter is niet gelijk aan de lengte van het bestand na het toevoegen van de geüploade gegevens." 400 Ongeldige aanvraag, InvalidHeaderValue, 'De waarde voor een van de HTTP-headers heeft niet de juiste indeling'. 400 Ongeldige aanvraag, OngeldigHttpVerb, 'Het opgegeven HTTP-werkwoord is ongeldig- het wordt niet herkend door de server'. 400 Ongeldige aanvraag, InvalidInput, 'Een van de aanvraaginvoer is ongeldig'. 400 Ongeldige aanvraag, InvalidPropertyName, 'De naam van een eigenschap mag niet leeg zijn'. 400 Ongeldige aanvraag, InvalidPropertyName, 'De eigenschapsnaam bevat ongeldige tekens'. 400 Ongeldige aanvraag, InvalidQueryParameterValue, 'Waarde voor een van de queryparameters die zijn opgegeven in de aanvraag-URI is ongeldig'. 400 Ongeldige aanvraag, InvalidResourceName, 'De opgegeven resourcenaam bevat ongeldige tekens'. 400 Ongeldige aanvraag, InvalidSourceUri, 'De bron-URI is ongeldig'. 400 Ongeldige aanvraag, InvalidUri, 'De aanvraag-URI is ongeldig'. 400 Ongeldige aanvraag, MissingRequiredHeader, 'Er is geen HTTP-header opgegeven die verplicht is voor deze aanvraag.' 400 Ongeldige aanvraag, MissingRequiredQueryParameter, 'Er is geen queryparameter opgegeven die verplicht is voor deze aanvraag.' 400 Ongeldige aanvraag, MultipleConditionHeadersNotSupported, 'Meerdere voorwaardeheaders worden niet ondersteund'. 400 Ongeldige aanvraag, OutOfRangeInput, 'Een van de aanvraaginvoer ligt buiten het bereik'. 400 Ongeldige aanvraag, OutOfRangeQueryParameterValue, 'Een van de queryparameters die zijn opgegeven in de aanvraag-URI valt buiten het toegestane bereik.' 400 Ongeldige aanvraag, Niet ondersteundHeader, 'Een van de headers die in de aanvraag zijn opgegeven, wordt niet ondersteund'. 400 Ongeldige aanvraag, UnsupportedQueryParameter, 'Een van de queryparameters die zijn opgegeven in de aanvraag-URI wordt niet ondersteund'. 400 Ongeldige aanvraag, UnsupportedRestVersion, 'De opgegeven REST-versie wordt niet ondersteund'. 403 Verboden, AccountIsDisabled, 'Het opgegeven account is uitgeschakeld'. 403 Verboden, AuthorizationFailure, 'Deze aanvraag is niet gemachtigd om deze bewerking uit te voeren'. 403 Forbidden, InsufficientAccountPermissions, "Het account dat wordt geopend, heeft niet voldoende machtigingen om deze bewerking uit te voeren." 404 Niet gevonden, BestandssysteemNotFound, 'Het opgegeven bestandssysteem bestaat niet'. 404 Niet gevonden, PathNotFound, 'Het opgegeven pad bestaat niet'. 404 Niet gevonden, RenameDestinationParentPathNotFound, 'De bovenliggende map van het doelpad bestaat niet'. 404 Niet gevonden, ResourceNotFound, 'De opgegeven resource bestaat niet'. 404 Niet gevonden, SourcePathNotFound, 'Het bronpad voor een hernoembewerking bestaat niet'. Methode 405 Niet toegestaan, Niet-ondersteundHttpVerb, 'De resource ondersteunt het opgegeven HTTP-werkwoord niet'. 409 Conflict, DestinationPathIsBeingDeleted, 'Het opgegeven doelpad is gemarkeerd om te worden verwijderd'. 409 Conflict, DirectoryNotEmpty, 'De waarde van de recursieve queryparameter moet waar zijn om een niet-lege map te verwijderen'. 409 Conflict, FilesystemAlreadyExists, 'Het opgegeven bestandssysteem bestaat al'. 409 Conflict, FilesystemBeingDeleted, 'Het opgegeven bestandssysteem wordt verwijderd'. 409 Conflict, InvalidDestinationPath, 'Het opgegeven pad, of een element van het pad, bestaat en het resourcetype is ongeldig voor deze bewerking.' * 409 Conflict, InvalidFlushOperation, 'De resource is gemaakt of gewijzigd door de Blob Service-API en kan niet worden geschreven door de Data Lake Storage Service-API.' 409 Conflict, InvalidRenameSourcePath, 'De bronmap mag niet hetzelfde zijn als de doelmap, noch kan de doelmap een submap van de bronmap zijn.' 409 Conflict, InvalidSourceOrDestinationResourceType, 'Het bron- en doelresourcetype moet identiek zijn'. 409 Conflict, LeaseAlreadyPresent, "Er is al een lease aanwezig." 409 Conflict, LeaseIdMismatchWithLeaseOperation, "De opgegeven lease-id komt niet overeen met de lease-id voor de resource met de opgegeven leasebewerking." 409 Conflict, LeaseIsAlreadyBroken, "De lease is al verbroken en kan niet opnieuw worden verbroken." 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, "De lease-id komt overeen, maar de lease heeft momenteel de status Breken en kan niet worden verkregen totdat deze is verbroken." 409 Conflict, LeaseIsBreakingAndCannotBeChanged, 'De lease-id komt overeen, maar de lease heeft momenteel de status Breken en kan niet worden gewijzigd'. 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, 'De lease-id komt overeen, maar de lease is expliciet verbroken en kan niet worden vernieuwd'. 409 Conflict, LeaseNameMismatch, "De opgegeven leasenaam komt niet overeen met de bestaande leasenaam." 409 Conflict, LeaseNotPresentWithLeaseOperation, 'De lease-id is niet aanwezig bij de opgegeven leasebewerking'. 409 Conflict, PathAlreadyExists, 'Het opgegeven pad bestaat al'. 409 Conflict, PathConflict, 'Het opgegeven pad of een element van het pad bestaat en het resourcetype is ongeldig voor deze bewerking.' 409 Conflict, SourcePathIsBeingDeleted, 'Het opgegeven bronpad is gemarkeerd om te worden verwijderd'. 409 Conflict, ResourceTypeMismatch, 'Het resourcetype dat in de aanvraag is opgegeven, komt niet overeen met het type van de resource'. 412 Voorwaarde mislukt, ConditionNotMet, 'Aan de voorwaarde die is opgegeven met behulp van voorwaardelijke HTTP-header(s) is niet voldaan.' 412 Voorwaarde mislukt, LeaseIdMismatch, 'De opgegeven lease-id komt niet overeen met de lease-id voor de resource'. 412 Voorwaarde is mislukt, LeaseIdMissing: 'Er is momenteel een lease voor de resource en er is geen lease-id opgegeven in de aanvraag'. 412 Voorwaarde mislukt, LeaseNotPresent, 'Er is momenteel geen lease voor de resource.' 412 Voorwaarde mislukt, LeaseLost, 'Er is een lease-id opgegeven, maar de lease voor de resource is verlopen'. 412 Voorwaarde mislukt, SourceConditionNotMet, 'Er is niet voldaan aan de bronvoorwaarde die is opgegeven met behulp van voorwaardelijke HTTP-header(s). 413 Aanvraagentiteit is te groot, RequestBodyTooLarge, "De aanvraagbody is te groot en overschrijdt de maximaal toegestane limiet." 416 Aangevraagd bereik is niet bevredigend, InvalidRange, 'Het opgegeven bereik is ongeldig voor de huidige grootte van de resource'. 500 Interne serverfout, InternalError, 'Er is een interne fout opgetreden op de server. Probeer de aanvraag opnieuw uit te proberen.' 500 Interne serverfout, OperationTimedOut, 'De bewerking kan niet worden voltooid binnen de toegestane tijd'. 503 Service niet beschikbaar, ServerBusy, 'Uitgaand verkeer heeft de accountlimiet overschreden'. 503 Service niet beschikbaar, ServerBusy, 'Inkomend verkeer overschrijdt de accountlimiet'. 503 Service niet beschikbaar, ServerBusy, 'Bewerkingen per seconde overschrijdt de accountlimiet'. 503 Service niet beschikbaar, ServerBusy, 'De server kan momenteel geen aanvragen ontvangen. Probeer uw aanvraag opnieuw.' Kopteksten x-ms-request-id: string x-ms-version: string

Definities

Name	Description
DataLakeStorageError
Error	Het antwoordobject voor servicefouten.
FilesystemResourceType	De waarde moet 'bestandssysteem' zijn voor alle bestandssysteembewerkingen.
Path
PathList

DataLakeStorageError

Name	Type	Description
error	Error	Het antwoordobject voor servicefouten.

Error

Het antwoordobject voor servicefouten.

Name	Type	Description
code	string	De foutcode van de service.
message	string	Het servicefoutbericht.

FilesystemResourceType

De waarde moet 'bestandssysteem' zijn voor alle bestandssysteembewerkingen.

Name	Type	Description
filesystem	string

Path

Name	Type	Default value	Description
contentLength	integer
etag	string
group	string
isDirectory	boolean	False
lastModified	string
name	string
owner	string
permissions	string
x-ms-encryption-context	string		Als de eigenschapswaarde van de versleutelingscontext is ingesteld, wordt de ingestelde waarde geretourneerd. Alleen geldig wanneer hiërarchische naamruimte is ingeschakeld voor het account.
x-ms-encryption-key-sha256	string		De server echot de SHA256 van de door de klant verstrekte versleutelingssleutel om de sleutel te valideren die in de bewerking wordt gebruikt.
x-ms-encryption-scope	string		Als de aanvraag een versleutelingsbereik heeft gebruikt, zodat de client ervoor kan zorgen dat de inhoud van de aanvraag is versleuteld met behulp van het versleutelingsbereik.
x-ms-server-encrypted: true/false	boolean		De waarde van deze header wordt ingesteld op true als de inhoud van de aanvraag is versleuteld met behulp van het opgegeven algoritme.

PathList

Name	Type	Description
paths	Path[]