Share via

Path - List

  • Referencia
Service:
Storage Services
API Version:
2023-08-03

Az elérési utak és tulajdonságaik listázása az adott fájlrendszerben.

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

URI-paraméterek

Name In Kötelező Típus Description
accountName
 path True

string

Az Azure Storage-fiók neve.
dnsSuffix
 path True

string

A Azure Data Lake Storage végpont DNS-utótagja.
filesystem
 path True

string

A fájlrendszer azonosítója. Az értéknek betűvel vagy számmal kell kezdődnie és végződnie, és csak betűket, számokat és kötőjelet (-) tartalmazhat. Egymást követő kötőjelek nem engedélyezettek. Minden betűnek kisbetűsnek kell lennie. Az értéknek 3 és 63 karakter közöttinek kell lennie.

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

boolean

Ha "igaz", az összes elérési út megjelenik; ellenkező esetben csak a fájlrendszer gyökerében lévő elérési utak jelennek meg. Ha a "könyvtár" meg van adva, a lista csak azokat az elérési utakat tartalmazza, amelyek ugyanazt a gyökért használják.
resource
 query True

FilesystemResourceType

Az értéknek "fájlrendszernek" kell lennie az összes fájlrendszerművelethez.
continuation
 query

string

Az egyes hívásokkal visszaadott elérési utak száma korlátozott. Ha a visszaadandó elérési utak száma meghaladja ezt a korlátot, a rendszer egy folytatási jogkivonatot ad vissza az x-ms-continuation válaszfejlécben. Ha egy folytatási jogkivonatot ad vissza a válaszban, meg kell adnia a listaművelet későbbi meghívásában az elérési utak listázásának folytatásához. Vegye figyelembe, hogy az x-ms-continuation válaszfejlécben visszaadott folytatási jogkivonatnak URL-címet kell kódolnia, mielőtt egy későbbi meghívásban használna.
directory
 query

string

Az eredményeket a megadott könyvtárban lévő elérési utakra szűri. Hiba történik, ha a könyvtár nem létezik.
maxResults
 query

integer

int32

Nem kötelező érték, amely a visszaadandó elemek maximális számát határozza meg. Ha nincs megadva vagy nagyobb, mint 5000, a válasz legfeljebb 5000 elemet tartalmaz.
timeout
 query

integer

int32

Egy nem kötelező művelet időtúllépési értéke másodpercben. Az időszak akkor kezdődik, amikor a kérést a szolgáltatás megkapja. Ha az időtúllépési érték a művelet befejezése előtt eltelik, a művelet sikertelen lesz.
upn
 query

boolean

Választható. Csak akkor érvényes, ha a fiókhoz engedélyezve van a hierarchikus névtér. Ha "igaz", az egyes listabejegyzések tulajdonos- és csoportmezőiben visszaadott felhasználói identitásértékek Azure Active Directory-objektumazonosítókból egyszerű felhasználónevekké alakulnak át. Ha "false" (hamis) értékeket ad vissza, a rendszer Azure Active Directory-objektumazonosítóként adja vissza az értékeket. Az alapértelmezett érték a hamis. Vegye figyelembe, hogy a csoport- és alkalmazásobjektum-azonosítók nincsenek lefordítva, mert nem rendelkeznek egyedi felhasználóbarát névvel.

Kérelem fejléce

Name Kötelező Típus Description
x-ms-client-request-id

string

Az elemzési naplókban a hibaelhárításhoz és a korrelációhoz rögzített UUID.

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

string

Megadja a kérés egyezményes világidő (UTC) formátumban kifejezett időpontját. Erre megosztott kulcs engedélyezésekor van szükség.
x-ms-version

string

A kérelem feldolgozásához használt REST protokoll verzióját adja meg. Erre megosztott kulcs engedélyezésekor van szükség.

Válaszok

Name Típus Description
200 OK

PathList

Oké

Headers

  • 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

Hiba történt. A lehetséges HTTP-állapotok, -kód- és üzenetsztringek az alábbiakban láthatók:

  • 400 Bad Request, ContentLengthMustBeZero, "A Content-Length kérés fejlécének nullának kell lennie."
  • 400 Bad Request, InvalidAuthenticationInfo, "A hitelesítési adatok nem a megfelelő formátumban adhatók meg. Ellenőrizze az Engedélyezési fejléc értékét."
  • 400 Bad Request, InvalidFlushPosition, "A feltöltött adatok nem folytonosak, vagy a pozíció lekérdezési paraméter értéke nem egyenlő a fájl hosszával a feltöltött adatok hozzáfűzése után."
  • 400 Bad Request, InvalidHeaderValue, "Az egyik HTTP-fejléc értéke nem a megfelelő formátumú."
  • 400 Hibás kérés, ÉrvénytelenHttpVerb, "A megadott HTTP-parancs érvénytelen – a kiszolgáló nem ismeri fel."
  • 400 Bad Request, InvalidInput, "Az egyik kérés bemenete érvénytelen."
  • 400 Bad Request, InvalidPropertyName, "A tulajdonságnév nem lehet üres."
  • 400 Bad Request, InvalidPropertyName, "A tulajdonságnév érvénytelen karaktereket tartalmaz."
  • 400 Bad Request, InvalidQueryParameterValue, "A kérelem URI-jában megadott lekérdezési paraméterek egyikének értéke érvénytelen."
  • 400 Hibás kérelem, InvalidResourceName, "A megadott erőforrásnév érvénytelen karaktereket tartalmaz."
  • 400 Hibás kérelem, InvalidSourceUri, "A forrás URI érvénytelen."
  • 400 Hibás kérelem, InvalidUri, "A kérelem URI-ja érvénytelen."
  • 400 Bad Request, MissingRequiredHeader, "A kéréshez kötelező HTTP-fejléc nincs megadva."
  • 400 Bad Request, MissingRequiredQueryParameter, "A kéréshez kötelező lekérdezési paraméter nincs megadva."
  • 400 Hibás kérés, MultipleConditionHeadersNotSupported, "Több feltételfejléc nem támogatott."
  • 400 Bad Request, OutOfRangeInput, "Az egyik kérés bemenete kívül esik a tartományon."
  • 400 Bad Request, OutOfRangeQueryParameterValue, "A kérelem URI-jában megadott egyik lekérdezési paraméter kívül esik a megengedett tartományon."
  • 400 Bad Request, UnsupportedHeader, "A kérelemben megadott fejlécek egyike nem támogatott."
  • 400 Bad Request, UnsupportedQueryParameter, "A kérelem URI-jában megadott egyik lekérdezési paraméter nem támogatott."
  • 400 Hibás kérés, Nem támogatottRestVersion, "A megadott rest verzió nem támogatott."
  • 403 Tiltott, AccountIsDisabled, "A megadott fiók le van tiltva."
  • 403 Tiltott, AuthorizationFailure, "Ez a kérelem nem jogosult a művelet végrehajtására."
  • 403 Tiltott, InsufficientAccountPermissions: "A hozzáférés alatt álló fiók nem rendelkezik a művelet végrehajtásához szükséges engedélyekkel."
  • 404 Nem található, FilesystemNotFound, "A megadott fájlrendszer nem létezik."
  • 404 Nem található, PathNotFound, "A megadott elérési út nem létezik."
  • 404 Nem található, RenameDestinationParentPathNotFound, "A célútvonal szülőkönyvtára nem létezik."
  • 404 Nem található, ResourceNotFound, "A megadott erőforrás nem létezik."
  • 404 Nem található, SourcePathNotFound, "Az átnevezési művelet forrásútvonala nem létezik."
  • 405 Method Not Allowed, UnsupportedHttpVerb, "Az erőforrás nem támogatja a megadott HTTP-parancsot."
  • 409 Conflict, DestinationPathIsBeingDeleted, "A megadott célútvonal törölendőként van megjelölve."
  • 409 Conflict, DirectoryNotEmpty, "A rekurzív lekérdezési paraméter értékének igaznak kell lennie egy nem üres könyvtár törléséhez."
  • 409 Conflict, FilesystemAlreadyExists, "A megadott fájlrendszer már létezik."
  • 409 Conflict, FilesystemBeingDeleted, "A megadott fájlrendszer törölve van."
  • 409 Conflict, InvalidDestinationPath, "A megadott elérési út vagy az elérési út egy eleme létezik, és az erőforrástípusa érvénytelen ehhez a művelethez." * 409 Conflict, InvalidFlushOperation, "Az erőforrást a Blob Service API hozta létre vagy módosította, és a Data Lake Storage Service API nem tudja írni."
  • 409 Conflict, InvalidRenameSourcePath, "A forráskönyvtár nem lehet ugyanaz, mint a célkönyvtár, és a cél nem lehet a forráskönyvtár alkönyvtára."
  • 409 Conflict, InvalidSourceOrDestinationResourceType, "A forrás és a cél erőforrástípusának azonosnak kell lennie."
  • 409 Conflict, LeaseAlreadyPresent, "Már létezik bérlet."
  • 409 Conflict, LeaseIdMismatchWithLeaseOperation, "A megadott bérletazonosító nem egyezett meg az erőforrás bérletazonosítójával a megadott bérletművelettel."
  • 409 Conflict, LeaseIsAlreadyBroken, "A bérlet már megszakadt, és nem törhető meg újra."
  • 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, "A bérletazonosító megfelelt, de a bérlet jelenleg kompatibilitástörő állapotban van, és nem szerezhető be, amíg meg nem törik."
  • 409 Conflict, LeaseIsBreakingAndCannotBeChanged, "A bérlet azonosítója megfelelt, de a bérlet jelenleg kompatibilitástörő állapotban van, és nem módosítható."
  • 409 Conflict, LeaseIsBrokenAndCannotBeRenewed: "A bérletazonosító megfelelt, de a bérlet explicit módon megszakadt, és nem újítható meg."
  • 409 Conflict, LeaseNameMismatch, "A megadott bérletnév nem egyezett meg a meglévő bérletnévvel."
  • 409 Conflict, LeaseNotPresentWithLeaseOperation, "A bérletazonosító nincs jelen a megadott bérletművelettel."
  • 409 Conflict, PathAlreadyExists, "A megadott elérési út már létezik."
  • 409 Ütközés, PathConflict, "A megadott elérési út vagy az elérési út egy eleme létezik, és az erőforrástípusa érvénytelen ehhez a művelethez."
  • 409 Conflict, SourcePathIsBeingDeleted, "A megadott forrásútvonal törölendőként van megjelölve."
  • 409 Conflict, ResourceTypeMismatch, "A kérelemben megadott erőforrástípus nem egyezik meg az erőforrás típusával."
  • 412 Az előfeltétel sikertelen, ConditionNotMet, "A HTTP feltételes fejléc(ek) használatával megadott feltétel nem teljesül."
  • 412 Az előfeltétel meghiúsult, LeaseIdMismatch, "A megadott bérletazonosító nem egyezett meg az erőforrás bérletazonosítójával."
  • 412 Az előfeltétel meghiúsult, LeaseIdMissing, "Jelenleg bérlet van az erőforráson, és nem adott meg bérletazonosítót a kérelemben."
  • 412 Az előfeltétel meghiúsult, LeaseNotPresent, "Jelenleg nincs bérlet az erőforráson."
  • 412 Az előfeltétel meghiúsult, LeaseLost, "A bérletazonosító meg lett adva, de az erőforrás bérlete lejárt."
  • 412 Az előfeltétel sikertelen, SourceConditionNotMet, "A HTTP feltételes fejléc(ek) használatával megadott forrásfeltétel nem teljesül."
  • 413 Request Entity Too Large, RequestBodyTooLarge, "A kérelemtörzs túl nagy, és meghaladja a megengedett maximális korlátot."
  • 416 A kért tartomány nem megfelelő, InvalidRange, "A megadott tartomány érvénytelen az erőforrás aktuális méretéhez."
  • 500 Internal Server Error, InternalError, "A kiszolgáló belső hibát észlelt. Próbálkozzon újra a kéréssel."
  • 500 Belső kiszolgálóhiba, OperationTimedOut, "A művelet nem hajtható végre a megengedett időn belül."
  • 503 A szolgáltatás nem érhető el, ServerBusy, "A kimenő forgalom túllépte a fiók korlátját".
  • 503 A szolgáltatás nem érhető el, ServerBusy, "A bejövő forgalom meghaladja a fiók korlátját".
  • 503 A szolgáltatás nem érhető el, ServerBusy, "A másodpercenkénti műveletek túllépik a fiókkorlátot".
  • 503 A szolgáltatás nem érhető el, ServerBusy, "A kiszolgáló jelenleg nem tud kéréseket fogadni. Próbálkozzon újra a kéréssel."

Headers

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

Definíciók

Name Description
DataLakeStorageError
Error

A szolgáltatáshiba-válasz objektum.
FilesystemResourceType

Az értéknek "fájlrendszernek" kell lennie az összes fájlrendszerművelethez.
Path
PathList

DataLakeStorageError

Name Típus Description
error

Error

A szolgáltatáshiba-válasz objektum.

Error

A szolgáltatáshiba-válasz objektum.

Name Típus Description
code

string

A szolgáltatás hibakódja.
message

string

A szolgáltatás hibaüzenete.

FilesystemResourceType

Az értéknek "fájlrendszernek" kell lennie az összes fájlrendszerművelethez.

Name Típus Description
filesystem

string

Path

Name Típus Alapértelmezett érték Description
contentLength

integer

eTag

string

group

string

isDirectory

boolean

False
lastModified

string

name

string

owner

string

permissions

string

x-ms-encryption-context

string

Ha a titkosítási környezet tulajdonságértéke be van állítva, akkor a beállított értéket adja vissza. Csak akkor érvényes, ha a fiókhoz engedélyezve van a hierarchikus névtér.
x-ms-encryption-key-sha256

string

A kiszolgáló az ügyfél által megadott titkosítási kulcs SHA256-ját fogja visszahangosíteni a műveletben használt kulcs ellenőrzéséhez.
x-ms-encryption-scope

string

Ha a kérelem titkosítási hatókört használt, így az ügyfél meggyőződhet arról, hogy a kérés tartalma sikeresen titkosítva van a titkosítási hatókör használatával.
x-ms-server-encrypted: true/false

boolean

A fejléc értéke igaz értékre van állítva, ha a kérés tartalma sikeresen titkosítva van a megadott algoritmussal.

PathList

Name Típus Description
paths

Path[]