Dela via

Path - List

  • Referens
Tjänst:
Storage Services
API-version:
2023-08-03

Lista sökvägar och deras egenskaper i det angivna filsystemet.

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

URI-parametrar

Name I Obligatorisk Typ Description
accountName
 path True

string

Namnet på Azure Storage-kontot.
dnsSuffix
 path True

string

DNS-suffixet för Azure Data Lake Storage-slutpunkten.
filesystem
 path True

string

Filsystemidentifieraren. Värdet måste börja och sluta med en bokstav eller siffra och får endast innehålla bokstäver, siffror och bindestreck (-). Streck i följd är inte tillåtna. Alla bokstäver måste vara gemener. Värdet måste innehålla mellan 3 och 63 tecken.

Reguljärt uttrycksmönster: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$
recursive
 query True

boolean

Om "sant" visas alla sökvägar. Annars visas endast sökvägar i filsystemets rot. Om "katalog" anges innehåller listan endast sökvägar som delar samma rot.
resource
 query True

FilesystemResourceType

Värdet måste vara "filesystem" för alla filsystemsåtgärder.
continuation
 query

string

Antalet sökvägar som returneras med varje anrop är begränsat. Om antalet sökvägar som ska returneras överskrider den här gränsen returneras en fortsättningstoken i svarshuvudet x-ms-continuation. När en fortsättningstoken returneras i svaret måste den anges i ett efterföljande anrop av liståtgärden för att fortsätta lista sökvägarna. Observera att fortsättningstoken som returneras i svarshuvudet x-ms-continuation måste vara URL-kodad innan den används i ett efterföljande anrop.
directory
 query

string

Filtrerar resultat till sökvägar i den angivna katalogen. Ett fel uppstår om katalogen inte finns.
maxResults
 query

integer

int32

Ett valfritt värde som anger det maximala antalet objekt som ska returneras. Om svaret utelämnas eller är större än 5 000 innehåller det upp till 5 000 objekt.
timeout
 query

integer

int32

Ett valfritt timeout-värde för åtgärden i sekunder. Perioden börjar när begäran tas emot av tjänsten. Om timeout-värdet förflutit innan åtgärden slutförs misslyckas åtgärden.
upn
 query

boolean

Valfritt. Gäller endast när hierarkiskt namnområde är aktiverat för kontot. Om det är "sant" omvandlas användaridentitetsvärdena som returneras i ägar- och gruppfälten för varje listpost från Azure Active Directory-objekt-ID:er till Användarnamn. Om värdet är "falskt" returneras värdena som Azure Active Directory-objekt-ID:t. Standardvärdet är false. Observera att grupp- och programobjekt-ID:t inte översätts eftersom de inte har unika egna namn.

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-client-request-id

string

Ett UUID som registrerats i analysloggarna för felsökning och korrelation.

Reguljärt uttrycksmönster: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
x-ms-date

string

Anger Coordinated Universal Time (UTC) för begäran. Detta krävs när du använder auktorisering av delad nyckel.
x-ms-version

string

Anger versionen av REST-protokollet som används för bearbetning av begäran. Detta krävs när du använder auktorisering av delad nyckel.

Svar

Name Typ Description
200 OK

PathList

Okej

Sidhuvuden

  • 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

Ett fel inträffade. De möjliga HTTP-status-, kod- och meddelandesträngarna visas nedan:

  • 400 Felaktig begäran, ContentLengthMustBeZero, "Rubriken för innehållslängdsbegäran måste vara noll".
  • 400 Felaktig begäran, InvalidAuthenticationInfo, "Autentiseringsinformation ges inte i rätt format. Kontrollera värdet för auktoriseringsrubriken."
  • 400 Felaktig begäran, InvalidFlushPosition, "Uppladdade data är inte sammanhängande eller värdet för frågeparametern position är inte lika med filens längd efter att de uppladdade data har lagts till."
  • 400 Felaktig begäran, InvalidHeaderValue, "Värdet för en av HTTP-huvudena är inte i rätt format."
  • 400 Felaktig begäran, InvalidHttpVerb, "Det angivna HTTP-verbet är ogiltigt – det känns inte igen av servern."
  • 400 Felaktig begäran, InvalidInput, "En av indata för begäran är inte giltig".
  • 400 Felaktig begäran, InvalidPropertyName, "Ett egenskapsnamn får inte vara tomt".
  • 400 Felaktig begäran, InvalidPropertyName, "Egenskapsnamnet innehåller ogiltiga tecken".
  • 400 Felaktig begäran, InvalidQueryParameterValue, "Värdet för en av frågeparametrarna som anges i begärans URI är ogiltigt".
  • 400 Felaktig begäran, InvalidResourceName, "Det angivna resursnamnet innehåller ogiltiga tecken".
  • 400 Felaktig begäran, InvalidSourceUri, "Käll-URI:n är ogiltig".
  • 400 Felaktig begäran, InvalidUri, "Begärande-URI:n är ogiltig".
  • 400 Felaktig begäran, MissingRequiredHeader, "Ett HTTP-huvud som är obligatoriskt för den här begäran har inte angetts."
  • 400 Felaktig begäran, MissingRequiredQueryParameter, "En frågeparameter som är obligatorisk för den här begäran har inte angetts.".
  • 400 Felaktig begäran, MultipleConditionHeadersNotSupported, "Flera villkorsrubriker stöds inte.".
  • 400 Felaktig begäran, OutOfRangeInput, "En av indata för begäran är inte inom intervallet."
  • 400 Bad Request, OutOfRangeQueryParameterValue, "En av frågeparametrarna som anges i begärande-URI:n ligger utanför det tillåtna intervallet."
  • 400 Felaktig begäran, UnsupportedHeader, "En av huvudena som anges i begäran stöds inte."
  • 400 Felaktig begäran, UnsupportedQueryParameter, "En av frågeparametrarna som anges i begärans URI stöds inte."
  • 400 Felaktig begäran,RestVersion stöds inte, "Den angivna restversionen stöds inte".
  • 403 Förbjuden, AccountIsDisabled, "Det angivna kontot är inaktiverat".
  • 403 Förbjuden, AuthorizationFailure, "Denna begäran har inte behörighet att utföra den här åtgärden."
  • 403 Förbjudet, InsufficientAccountPermissions, "Kontot som används har inte tillräcklig behörighet för att köra den här åtgärden.".
  • 404 Hittades inte, FilesystemNotFound, "Det angivna filsystemet finns inte.".
  • 404 Hittades inte, PathNotFound, "Den angivna sökvägen finns inte".
  • 404 Hittades inte, RenameDestinationParentPathNotFound, "Målsökvägens överordnade katalog finns inte".
  • 404 Hittades inte, ResourceNotFound, "Den angivna resursen finns inte".
  • 404 Not Found, SourcePathNotFound, "Källsökvägen för en namnbytesåtgärd finns inte."
  • 405 Method Not Allowed, UnsupportedHttpVerb, "Resursen stöder inte det angivna HTTP-verbet."
  • 409 Konflikt, DestinationPathIsBeingDeleted, "Den angivna målsökvägen markeras som borttagen".
  • 409 Konflikt, DirectoryNotEmpty, "Det rekursiva frågeparametervärdet måste vara sant för att ta bort en icke-tom katalog."
  • 409 Conflict, FilesystemAlreadyExists, "Det angivna filsystemet finns redan".
  • 409 Conflict, FilesystemBeingDeleted, "Det angivna filsystemet tas bort".
  • 409 Conflict, InvalidDestinationPath, "Den angivna sökvägen eller ett element i sökvägen finns och dess resurstyp är ogiltig för den här åtgärden." * 409 Conflict, InvalidFlushOperation, "Resursen skapades eller ändrades av Blob Service-API:et och kan inte skrivas till av Data Lake Storage Service-API:et."
  • 409 Conflict, InvalidRenameSourcePath, "Källkatalogen får inte vara samma som målkatalogen och kan inte heller vara en underkatalog till källkatalogen."
  • 409 Konflikt, InvalidSourceOrDestinationResourceType, "Käll- och målresurstypen måste vara identisk."
  • 409 Konflikt, LeaseAlreadyPresent, "Det finns redan ett lån."
  • 409 Konflikt, LeaseIdMismatchWithLeaseOperation, "Det angivna låne-ID:t matchade inte låne-ID:t för resursen med den angivna låneåtgärden."
  • 409 Konflikt, LeaseIsAlreadyBroken, "Lånet har redan brutits och kan inte brytas igen."
  • 409 Konflikt, LeaseIsBreakingAndCannotBeAcquired, "Låne-ID matchade, men lånet är för närvarande i icke-bakåtkompatibelt tillstånd och kan inte förvärvas förrän det bryts."
  • 409 Konflikt, LeaseIsBreakingAndCannotBeChanged, "Låne-ID matchade, men lånet är för närvarande i icke-bakåtkompatibelt tillstånd och kan inte ändras."
  • 409 Konflikt, LeaseIsBrokenAndCannotBeRenewed, "Låne-ID matchade, men lånet har brutits uttryckligen och kan inte förnyas."
  • 409 Konflikt, LeaseNameMismatch, "Det angivna lånenamnet matchade inte det befintliga lånenamnet."
  • 409 Konflikt, LeaseNotPresentWithLeaseOperation, "Låne-ID:t finns inte med den angivna låneåtgärden."
  • 409 Konflikt, PathAlreadyExists, "Den angivna sökvägen finns redan".
  • 409 Konflikt, PathConflict, "Den angivna sökvägen eller ett element i sökvägen finns och dess resurstyp är ogiltig för den här åtgärden."
  • 409 Conflict, SourcePathIsBeingDeleted, "Den angivna källsökvägen har markerats som borttagen".
  • 409 Konflikt, ResourceTypeMismatch, "Resurstypen som anges i begäran matchar inte resurstypen."
  • 412 Förhandsvillkoret misslyckades, ConditionNotMet, "Villkoret som anges med villkorsstyrda HTTP-huvuden är inte uppfyllt."
  • 412 Förhandsvillkoret misslyckades, LeaseIdMismatch, "Det angivna låne-ID:t matchade inte låne-ID:t för resursen."
  • 412 Förhandsvillkoret misslyckades, LeaseIdMissing, "Det finns för närvarande ett lån på resursen och inget låne-ID angavs i begäran."
  • 412 Förhandsvillkoret misslyckades, LeaseNotPresent, "Det finns för närvarande inget lån på resursen."
  • 412 Förhandsvillkoret misslyckades, LeaseLost, "Ett låne-ID angavs, men lånet för resursen har upphört att gälla."
  • 412 Förutsättning misslyckades, SourceConditionNotMet, "Källvillkoret som anges med villkorsstyrda HTTP-huvuden är inte uppfyllt."
  • 413 Begärandeentiteten är för stor, RequestBodyTooLarge, "Begärandetexten är för stor och överskrider den maximala tillåtna gränsen."
  • 416 Det begärda området är inte uppfyllt, InvalidRange, "Det angivna intervallet är ogiltigt för resursens aktuella storlek.".
  • 500 Internt serverfel, InternalError, "Servern påträffade ett internt fel. Försök igen."
  • 500 Internt serverfel, OperationTimedOut, "Det gick inte att slutföra åtgärden inom den tillåtna tiden."
  • 503 Tjänsten är inte tillgänglig, ServerBusy, "Utgående trafik överskrider kontogränsen".
  • 503 Tjänsten är inte tillgänglig, ServerBusy, "Ingress is over the account limit".
  • 503 Tjänsten är inte tillgänglig, ServerBusy, "Åtgärder per sekund överskrider kontogränsen".
  • 503 Tjänsten är inte tillgänglig, ServerBusy, "Servern kan för närvarande inte ta emot begäranden. Försök igen."

Sidhuvuden

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

Definitioner

Name Description
DataLakeStorageError
Error

Svarsobjektet för tjänstfel.
FilesystemResourceType

Värdet måste vara "filesystem" för alla filsystemsåtgärder.
Path
PathList

DataLakeStorageError

Name Typ Description
error

Error

Svarsobjektet för tjänstfel.

Error

Svarsobjektet för tjänstfel.

Name Typ Description
code

string

Felkoden för tjänsten.
message

string

Tjänstfelmeddelandet.

FilesystemResourceType

Värdet måste vara "filesystem" för alla filsystemsåtgärder.

Name Typ Description
filesystem

string

Path

Name Typ Standardvärde Description
contentLength

integer

etag

string

group

string

isDirectory

boolean

False
lastModified

string

name

string

owner

string

permissions

string

x-ms-encryption-context

string

Om värdet för krypteringskontextegenskapen anges returneras det angivna värdet. Gäller endast när hierarkisk namnrymd är aktiverat för kontot.
x-ms-encryption-key-sha256

string

Servern upprepar SHA256 för den krypteringsnyckel som kunden tillhandahåller för att verifiera nyckeln som användes i åtgärden.
x-ms-encryption-scope

string

Om begäran använde ett krypteringsomfång, så att klienten kan se till att innehållet i begäran har krypterats med hjälp av krypteringsomfånget.
x-ms-server-encrypted: true/false

boolean

Värdet för det här huvudet är inställt på true om innehållet i begäran har krypterats med den angivna algoritmen.

PathList

Name Typ Description
paths

Path[]