Megosztás a következőn keresztül:


Path - List

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

GET https://{accountName}.{dnsSuffix}/{filesystem}?recursive={recursive}&resource=filesystem
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

Az Azure Data Lake Storage-végpont DNS-utótagja.

filesystem
path True

string

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

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 (-) kell tartalmaznia. Egymást követő kötőjelek nem engedélyezettek. Minden betűnek kisbetűnek kell lennie. Az értéknek 3 és 63 karakter közöttinek kell lennie.

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 az azonos gyökerű elérési utakat tartalmazza.

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 útvonalak száma korlátozott. Ha a visszaadandó útvonalak száma meghaladja ezt a korlátot, a rendszer egy folytatási jogkivonatot ad vissza az x-ms-folytatás válaszfejlécben. Ha egy folytatási jogkivonatot ad vissza a válaszban, azt a listaművelet egy későbbi meghívásában kell megadni az útvonalak listázásának folytatásához. Vegye figyelembe, hogy az x-ms-folytatás 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

Szűri az eredményeket a megadott könyvtár elérési útjaira. Hiba történik, ha a könyvtár nem létezik.

maxResults
query

integer (int32)

minimum: 1

Nem kötelező érték, amely meghatározza a visszaadandó elemek maximális számát. Ha nincs megadva vagy 5000-nél nagyobb, a válasz legfeljebb 5000 elemet tartalmaz.

timeout
query

integer (int32)

minimum: 1

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ődése előtt eltelik, a művelet meghiúsul.

upn
query

boolean

Opcionális. Csak akkor érvényes, ha a hierarchikus névtér engedélyezve van a fiókhoz. 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. Ha "hamis", a rendszer az értékeket Azure Active Directory-objektumazonosítókként adja vissza. Az alapértelmezett érték 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

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

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

x-ms-date

string

A kérelem koordinált egyetemes idejét (UTC) adja meg. Ez a megosztott kulcsok engedélyezéséhez szükséges.

x-ms-version

string

A kérelem feldolgozásához használt REST protokoll verzióját adja meg. Ez a megosztott kulcsok engedélyezéséhez szükséges.

Válaszok

Name Típus Description
200 OK

PathList

Oké

Fejlécek

  • 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ábbiak:

  • 400 Bad Request, ContentLengthMustBeZero, "A Content-Length kérelem fejlécének nullának kell lennie."
  • 400 Bad Request, InvalidAuthenticationInfo, "A hitelesítési információk nem a megfelelő formátumban jelennek meg. Ellenőrizze az Engedélyezési fejléc értékét."
  • 400 Bad Request, InvalidFlushPosition, "A feltöltött adatok nem egyeznek, 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átumban van."
  • 400 Bad Request, InvalidHttpVerb, "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 Hibás kérelem, InvalidPropertyName, "A tulajdonságnév nem lehet üres."
  • 400 Hibás kérelem, InvalidPropertyName, "A tulajdonságnév érvénytelen karaktereket tartalmaz."
  • 400 Bad Request, InvalidQueryParameterValue, "A kérelem URI-jában megadott egyik lekérdezési paraméter é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érelemhez 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 lekérdezési paraméterek egyike 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 lekérdezési paraméterek egyike nem támogatott."
  • 400 Bad Request, UnsupportedRestVersion, "A megadott rest verzió nem támogatott."
  • 403 Forbidden, AccountIsDisabled, "A megadott fiók le van tiltva."
  • 403 Forbidden, AuthorizationFailure, "Ez a kérés nem jogosult a művelet végrehajtására."
  • 403 Forbidden, InsufficientAccountPermissions, "A hozzáférés alatt álló fiók nem rendelkezik megfelelő engedélyekkel a művelet végrehajtásához."
  • 404 Not Found, 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 elérési út 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 Metódus nem engedélyezett, nem támogatottHttpVerb: "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 sem lehet a forráskönyvtár alkönyvtára."
  • 409 Conflict, InvalidSourceOrDestinationResourceType, "A forrás- és célerőforrás-típusnak azonosnak kell lennie."
  • 409 Conflict, LeaseAlreadyPresent, "Már létezik bérlet."
  • 409 Conflict, LeaseIdMismatchWithLeaseOperation: "A megadott bérletazonosító nem egyezett 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érlet azonosítója megfelelt, de a bérlet jelenleg feltört á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 feltört állapotban van, és nem módosítható."
  • 409 Conflict, LeaseIsBrokenAndCannotBeRenewed: "A bérlet azonosítója megfelelt, de a bérlet explicit módon megszakadt, és nem újítható meg."
  • 409 Conflict, LeaseNameMismatch, "A megadott bérletnév nem egyezett a meglévő bérlet nevével."
  • 409 Conflict, LeaseNotPresentWithLeaseOperation: "A bérletazonosító nincs jelen a megadott bérletműveletben."
  • 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örlésre van jelö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őkondicionálás 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 felelt meg az erőforrás bérletazonosítójának."
  • 412 Az előkondicionálás meghiúsult, LeaseIdMissing, "Jelenleg bérlet van az erőforráson, és a kérelemben nincs megadva bérletazonosító."
  • 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őkondicionálás 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érelem törzse 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 Internal Server Error, OperationTimedOut, "A művelet nem hajtható végre a megengedett időn belül."
  • 503 Szolgáltatás nem érhető el, ServerBusy: "A kimenő forgalom túllépte a fiókkorlátot."
  • 503 Szolgáltatás nem érhető el, ServerBusy: "A bejövő forgalom meghaladja a fiók korlátját."
  • 503 Szolgáltatás nem érhető el, ServerBusy: "A másodpercenkénti műveletek túllépik a fiókkorlátot."
  • 503 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."

Fejlécek

  • 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.

Érték Description
filesystem

Path

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

integer (int64)

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 megadott értéket adja vissza. Csak akkor érvényes, ha a hierarchikus névtér engedélyezve van a fiókhoz.

x-ms-encryption-key-sha256

string

A kiszolgáló az ügyfél által megadott titkosítási kulcs SHA256-ját fogja visszajelení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[]