Delen via

Path - List

  • Referentie
Service:
Storage Services
API-versie:
2023-08-03

Lijstpaden en de bijbehorende eigenschappen in het opgegeven bestandssysteem.

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

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

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.
recursive
 query True

boolean

Als 'waar' wordt weergegeven, worden alle paden vermeld; anders worden alleen paden in de hoofdmap van het bestandssysteem vermeld. 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 moet zijn gecodeerd voordat het wordt gebruikt in een volgende aanroep.
directory
 query

string

Filtert resultaten naar paden in de opgegeven map. Er treedt een fout op als de map niet bestaat.
maxResults
 query

integer (int32)

minimum: 1

Een optionele waarde waarmee het maximum aantal te retourneren items wordt opgegeven. Als u dit weglaat of groter is dan 5000, bevat het antwoord maximaal 5.000 items.
timeout
 query

integer (int32)

minimum: 1

Een optionele time-outwaarde voor bewerkingen in seconden. De periode begint wanneer de aanvraag door de service wordt ontvangen. Als de time-outwaarde is verstreken voordat de bewerking is voltooid, mislukt de bewerking.
upn
 query

boolean

Facultatief. Alleen geldig wanneer hiërarchische naamruimte is ingeschakeld voor het account. Als 'true', worden de waarden van de gebruikersidentiteit die worden geretourneerd in de eigenaar- en groepsvelden van elke lijstvermelding, getransformeerd van Azure Active Directory-object-id's naar User Principal Names. Als 'false', worden de waarden geretourneerd als Azure Active Directory-object-id's. De standaardwaarde is onwaar. 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

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

Een UUID die is vastgelegd in de analyselogboeken voor probleemoplossing en correlatie.
x-ms-date

string

Hiermee geeft u de Coordinated Universal Time (UTC) voor de aanvraag. Dit is vereist bij het gebruik van autorisatie van gedeelde sleutels.
x-ms-version

string

Hiermee geeft u de versie op van het REST-protocol 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. Hieronder ziet u de mogelijke HTTP-status, code en berichttekenreeksen:

  • 400 Ongeldige aanvraag, ContentLengthMustBeZero, "De aanvraagheader content-length moet nul zijn."
  • 400 Ongeldige aanvraag, InvalidAuthenticationInfo, "Verificatiegegevens worden niet gegeven in de juiste indeling. Controleer de waarde van de 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 nadat de geüploade gegevens zijn toegevoegd."
  • 400 Ongeldige aanvraag, InvalidHeaderValue, 'De waarde voor een van de HTTP-headers heeft niet de juiste indeling.'
  • 400 Ongeldige aanvraag, InvalidHttpVerb, '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, 'Een eigenschapsnaam mag niet leeg zijn'.
  • 400 Ongeldige aanvraag, InvalidPropertyName, 'De naam van de eigenschap 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, "Een HTTP-header die verplicht is voor deze aanvraag is niet opgegeven."
  • 400 Ongeldige aanvraag, MissingRequiredQueryParameter, 'Een queryparameter die verplicht is voor deze aanvraag is niet opgegeven'.
  • 400 Ongeldige aanvraag, MultipleConditionHeadersNotSupported, 'Headers met meerdere voorwaarden worden niet ondersteund'.
  • 400 Ongeldige aanvraag, OutOfRangeInput, 'Een van de aanvraaginvoer valt 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-ondersteundeHeader, "Een van de headers die zijn opgegeven in de aanvraag wordt niet ondersteund."
  • 400 Ongeldige aanvraag, Niet-ondersteundeQueryParameter, "Een van de queryparameters die zijn opgegeven in de aanvraag-URI wordt niet ondersteund."
  • 400 Ongeldige aanvraag, Niet-ondersteundeRestVersion, '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 Verboden, InsufficientAccountPermissions, "Het account dat wordt geopend, beschikt niet over voldoende machtigingen om deze bewerking uit te voeren."
  • 404 Niet gevonden, FilesystemNotFound, "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 naamswijzigingsbewerking bestaat niet."
  • Methode 405 Niet toegestaan, UnsupportedHttpVerb, 'De resource biedt geen ondersteuning voor het opgegeven HTTP-werkwoord'.
  • 409 Conflict, DestinationPathIsBeingDeleted, "Het opgegeven doelpad is gemarkeerd om te worden verwijderd."
  • 409 Conflict, DirectoryNotEmpty, "The recursive query parameter value must be true to delete a non-empty directory."
  • 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, en kan de bestemming ook geen 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, "The lease ID matched, but the lease is currently in breaking state and cannot be acquired until it is broken."
  • 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 met de opgegeven leasebewerking'.
  • 409 Conflict, PathAlreadyExists, "Het opgegeven pad bestaat al."
  • 409 Conflict, PathConflict, "The specified path, or an element of an element of the path, exists and its resource type is invalid for this operation."
  • 409 Conflict, SourcePathIsBeingDeleted, 'Het opgegeven bronpad is gemarkeerd om te worden verwijderd'.
  • 409 Conflict, ResourceTypeMismatch, "Het resourcetype dat is opgegeven in de aanvraag komt niet overeen met het type van de resource."
  • 412 Voorwaarde is mislukt, ConditionNotMet, "De voorwaarde die is opgegeven met behulp van HTTP-voorwaardelijke 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 is mislukt, LeaseNotPresent, 'Er is momenteel geen lease voor de resource.'
  • 412 Voorwaarde is mislukt, LeaseLost, 'Er is een lease-id opgegeven, maar de lease voor de resource is verlopen'.
  • 412 Condition Failed, SourceConditionNotMet, "The source condition specified using HTTP conditional header(s) is not voldoen."
  • 413 Aanvraagentiteit te groot, RequestBodyTooLarge, "De aanvraagbody is te groot en overschrijdt de maximaal toegestane limiet."
  • 416 Aangevraagd bereik niet satisfiable, 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.
  • 500 Interne serverfout, OperationTimedOut, "De bewerking kan niet worden voltooid binnen de toegestane tijd."
  • 503 Service Niet beschikbaar, ServerBusy, "Uitgaand verkeer overschrijdt de accountlimiet."
  • 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 de servicefout.
FilesystemResourceType

De waarde moet 'bestandssysteem' zijn voor alle bestandssysteembewerkingen.
Path
PathList

DataLakeStorageError

Object
Name Type Description
error

Error

Het antwoordobject voor de servicefout.

Error

Object

Het antwoordobject voor de servicefout.

Name Type Description
code

string

De servicefoutcode.
message

string

Het servicefoutbericht.

FilesystemResourceType

Inventarisatie

De waarde moet 'bestandssysteem' zijn voor alle bestandssysteembewerkingen.

Waarde Description
filesystem

Path

Object
Name Type Default value Description
contentLength

integer (int64)

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, kan de client ervoor 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 is ingesteld op true als de inhoud van de aanvraag is versleuteld met behulp van het opgegeven algoritme.

PathList

Object
Name Type Description
paths

Path[]