Sdílet prostřednictvím

Path - List

  • Reference
Služba:
Storage Services
Verze rozhraní API:
2023-08-03

Vypište cesty a jejich vlastnosti v daném systému souborů.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
accountName
 path True

string

Název účtu služby Azure Storage.
dnsSuffix
 path True

string

Přípona DNS pro koncový bod Azure Data Lake Storage.
filesystem
 path True

string

Identifikátor systému souborů. Hodnota musí začínat a končit písmenem nebo číslicí a musí obsahovat pouze písmena, číslice a znak pomlčky (-). Po sobě jdoucí pomlčky nejsou povoleny. Všechna písmena musí být malá. Hodnota musí mít 3 až 63 znaků.

Vzor regulárního výrazu: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$
recursive
 query True

boolean

Je-li "true", jsou uvedeny všechny cesty; v opačném případě jsou uvedeny pouze cesty v kořenovém adresáři systému souborů. Pokud zadáte "adresář", bude seznam obsahovat pouze cesty, které sdílejí stejný kořenový adresář.
resource
 query True

FilesystemResourceType

Hodnota musí být "systém souborů" pro všechny operace systému souborů.
continuation
 query

string

Počet cest vrácených při každém vyvolání je omezený. Pokud počet vrácených cest překročí tento limit, vrátí se token pokračování v hlavičce odpovědi x-ms-continuation. Pokud je v odpovědi vrácen token pokračování, musí být zadán v následném vyvolání operace seznamu, aby bylo možné pokračovat ve výpisu cest. Všimněte si, že token pro pokračování vrácený v hlavičce odpovědi x-ms-continuation musí být před použitím v následném volání zakódovaný v adrese URL.
directory
 query

string

Filtruje výsledky na cesty v rámci zadaného adresáře. Pokud adresář neexistuje, dojde k chybě.
maxResults
 query

integer

int32

Volitelná hodnota, která určuje maximální počet vrácených položek. Pokud je vynecháno nebo větší než 5 000, bude odpověď obsahovat až 5 000 položek.
timeout
 query

integer

int32

Volitelná hodnota časového limitu operace v sekundách. Období začíná tím, že služba obdrží požadavek. Pokud hodnota časového limitu uplynou před dokončením operace, operace selže.
upn
 query

boolean

Nepovinný parametr. Platí jenom v případě, že je pro účet povolený hierarchický obor názvů. Pokud je hodnota true, hodnoty identity uživatele vrácené v polích vlastníka a skupiny každé položky seznamu se transformují z ID objektů Azure Active Directory na hlavní názvy uživatelů. Pokud je false, vrátí se hodnoty jako ID objektů Azure Active Directory. Výchozí hodnota je False. Všimněte si, že ID objektů skupin a aplikací se nepřekládají, protože nemají jedinečné popisné názvy.

Hlavička požadavku

Name Vyžadováno Typ Description
x-ms-client-request-id

string

Identifikátor UUID zaznamenaný v analytických protokolech pro řešení potíží a korelaci.

Vzor regulárního výrazu: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
x-ms-date

string

Určuje formát UTC (Coordinated Universal Time). To se vyžaduje při použití autorizace sdíleného klíče.
x-ms-version

string

Určuje verzi protokolu REST, která se použije ke zpracování požadavku. To se vyžaduje při použití autorizace sdíleného klíče.

Odpovědi

Name Typ Description
200 OK

PathList

Ok

Hlavičky

  • 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

Došlo k chybě. Možné řetězce stavu HTTP, kódu a zprávy jsou uvedené níže:

  • 400 Chybný požadavek, ContentLengthMustBeZero, "Hlavička požadavku Content-Length musí být nulová."
  • 400 Chybný požadavek, InvalidAuthenticationInfo, "Ověřovací informace nejsou zadány ve správném formátu. Zkontrolujte hodnotu hlavičky Authorization.
  • 400 Chybný požadavek, InvalidFlushPosition, "Nahraná data nejsou souvislá nebo hodnota parametru dotazu position se nerovná délce souboru po připojení nahraných dat."
  • 400 Chybný požadavek, InvalidHeaderValue, "Hodnota jedné z hlaviček HTTP není ve správném formátu."
  • 400 – Chybný požadavek, InvalidHttpVerb, "Zadaný příkaz HTTP je neplatný – server ho nerozpoznal."
  • 400 Chybný požadavek, InvalidInput, "Jeden ze vstupů požadavku není platný."
  • 400 Chybný požadavek, InvalidPropertyName, "Název vlastnosti nemůže být prázdný."
  • 400 Chybný požadavek, InvalidPropertyName, "Název vlastnosti obsahuje neplatné znaky."
  • 400 – Chybný požadavek, InvalidQueryParameterValue, Hodnota jednoho z parametrů dotazu zadaných v identifikátoru URI požadavku je neplatná.
  • 400 – Chybný požadavek, InvalidResourceName, "Zadaný název prostředku obsahuje neplatné znaky."
  • 400 – Chybný požadavek, InvalidSourceUri, identifikátor URI zdroje je neplatný.
  • 400 – Chybný požadavek, InvalidUri, Identifikátor URI požadavku je neplatný.
  • 400 – Chybný požadavek, MissingRequiredHeader, "Není zadána hlavička HTTP, která je pro tento požadavek povinná."
  • 400 – Chybný požadavek, MissingRequiredQueryParameter, parametr dotazu, který je pro tento požadavek povinný, není zadaný.
  • 400 Chybný požadavek, MultipleConditionHeadersNotSupported, "Více hlaviček podmínek není podporováno."
  • 400 – Chybný požadavek, OutOfRangeInput, "Jeden ze vstupů požadavku je mimo rozsah."
  • 400 Chybný požadavek, OutOfRangeQueryParameterValue, "Jeden z parametrů dotazu zadaný v identifikátoru URI požadavku je mimo povolený rozsah."
  • 400 Chybný požadavek, UnsupportedHeader, "Jedna z hlaviček zadaných v požadavku není podporována."
  • 400 – Chybný požadavek, UnsupportedQueryParameter, "Jeden z parametrů dotazu zadaný v identifikátoru URI požadavku se nepodporuje."
  • 400 Chybný požadavek, UnsupportedRestVersion, "Zadaná verze REST není podporována."
  • 403 ForBidden, AccountIsDisabled, "Zadaný účet je zakázaný."
  • 403 ForBidden, AuthorizationFailure, "Tento požadavek nemá oprávnění k provedení této operace."
  • 403 ForBidden, InsufficientAccountPermissions, "Účet, ke kterým přistupujete, nemá dostatečná oprávnění k provedení této operace."
  • 404 Nenalezeno, FilesystemNotFound, "Zadaný systém souborů neexistuje."
  • 404 Nenalezeno, PathNotFound, "Zadaná cesta neexistuje."
  • 404 Nenalezeno, RenameDestinationParentPathNotFound, Nadřazený adresář cílové cesty neexistuje.
  • 404 Nenalezeno, ResourceNotFound, Zadaný prostředek neexistuje.
  • 404 Nenalezeno, SourcePathNotFound, Zdrojová cesta pro operaci přejmenování neexistuje.
  • Metoda 405 není povolená, unsupportedHttpVerb, "Prostředek nepodporuje zadaný příkaz HTTP."
  • 409 Conflict, DestinationPathIsBeingDeleted, "Zadaná cílová cesta je označena k odstranění."
  • 409 Conflict, DirectoryNotEmpty, "Hodnota parametru rekurzivního dotazu musí být true, aby bylo možné odstranit neprázdný adresář."
  • 409 Conflict, FilesystemAlreadyExists, "Zadaný systém souborů již existuje."
  • 409 Conflict, FilesystemBeingDeleted, "Zadaný systém souborů je odstraněn."
  • 409 Conflict, InvalidDestinationPath, "Zadaná cesta nebo prvek cesty existuje a typ prostředku je pro tuto operaci neplatný." * 409 – Konflikt, InvalidFlushOperation, Prostředek byl vytvořen nebo upraven rozhraním API služby Blob Service a rozhraní API služby Data Lake Storage do ho nemůže zapisovat.
  • 409 Conflict, InvalidRenameSourcePath, "Zdrojový adresář nemůže být stejný jako cílový adresář, ani cíl nemůže být podadresář zdrojového adresáře."
  • 409 Conflict, InvalidSourceOrDestinationResourceType, "Typ zdrojového a cílového prostředku musí být identický."
  • 409 Conflict, LeaseAlreadyPresent, "Již existuje zapůjčení."
  • 409 Conflict, LeaseIdMismatchWithLeaseOperation, "Zadané ID zapůjčení neodpovídá ID zapůjčení pro prostředek se zadanou operací zapůjčení."
  • 409 Conflict, LeaseIsAlreadyBroken, "Zapůjčení již bylo přerušeno a nelze ho znovu přerušit."
  • 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, "ID zapůjčení bylo spárováno, ale zapůjčení je aktuálně ve stavu přerušení a nelze jej získat, dokud není přerušeno."
  • 409 Conflict, LeaseIsBreakingAndCannotBeChanged, "ID zapůjčení se shoduje, ale zapůjčení je aktuálně ve stavu přerušení a nelze ho změnit."
  • 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, "ID zapůjčení se shoduje, ale zapůjčení bylo explicitně poškozeno a nelze jej obnovit."
  • 409 Conflict, LeaseNameMismatch, "Zadaný název zapůjčení neodpovídá názvu existujícího zapůjčení."
  • 409 – Konflikt, LeaseNotPresentWithLeaseOperation, ID zapůjčení neexistuje u zadané operace zapůjčení.
  • 409 Conflict, PathAlreadyExists, "Zadaná cesta již existuje."
  • 409 Konflikt, PathConflict, "Zadaná cesta nebo prvek cesty existuje a její typ prostředku je pro tuto operaci neplatný."
  • 409 Conflict, SourcePathIsBeingDeleted, "Zadaná zdrojová cesta je označena k odstranění."
  • 409 Conflict, ResourceTypeMismatch, "Typ prostředku zadaný v požadavku neodpovídá typu prostředku."
  • 412 Předběžná podmínka selhala, PodmínkaNotMet: Podmínka zadaná pomocí podmíněných hlaviček HTTP není splněna.
  • 412 Předběžná podmínka selhala, LeaseIdMismatch, Zadané ID zapůjčení neodpovídá ID zapůjčení prostředku.
  • 412 Předběžná podmínka se nezdařila, LeaseIdMissing: Prostředek aktuálně má zapůjčení a v žádosti nebylo zadáno žádné ID zapůjčení.
  • 412 Předběžná podmínka selhala, LeaseNotPresent, "Prostředek momentálně nemá žádné zapůjčení."
  • 412 Předběžná podmínka selhala, LeaseLost, "Bylo zadáno ID zapůjčení, ale vypršela platnost zapůjčení prostředku."
  • 412 Předběžná podmínka selhala, SourceConditionNotMet, "Zdrojová podmínka zadaná pomocí podmíněných hlaviček HTTP není splněna."
  • 413 Request Entity Too Large, RequestBodyTooLarge, "Text požadavku je příliš velký a překračuje maximální povolený limit."
  • 416 Požadovaný rozsah není uspokojitelný, InvalidRange, "Zadaný rozsah je neplatný pro aktuální velikost prostředku."
  • 500 Vnitřní chyba serveru, Vnitřní chyba: "Na serveru došlo k vnitřní chybě. Zkuste žádost zopakovat."
  • 500 Vnitřní chyba serveru OperationTimedOut, "Operaci nelze dokončit v povoleném čase."
  • 503 – Nedostupná služba, ServerBusy, Výchozí přenos dat překročil limit účtu.
  • 503 – Nedostupná služba, ServerBusy, Příchozí přenos dat překročil limit účtu.
  • 503 – Nedostupná služba, ServerBusy, Operace za sekundu překročily limit účtu.
  • 503 – Nedostupná služba, ServerBusy, "Server momentálně nemůže přijímat požadavky. Zkuste prosím žádost zopakovat."

Hlavičky

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

Definice

Name Description
DataLakeStorageError
Error

Objekt odpovědi na chybu služby.
FilesystemResourceType

Hodnota musí být "filesystem" pro všechny operace systému souborů.
Path
PathList

DataLakeStorageError

Name Typ Description
error

Error

Objekt odpovědi na chybu služby.

Error

Objekt odpovědi na chybu služby.

Name Typ Description
code

string

Kód chyby služby.
message

string

Chybová zpráva služby.

FilesystemResourceType

Hodnota musí být "filesystem" pro všechny operace systému souborů.

Name Typ Description
filesystem

string

Path

Name Typ 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

Pokud je nastavená hodnota vlastnosti kontextu šifrování, vrátí se nastavená hodnota. Platí pouze v případě, že je pro účet povolený hierarchický obor názvů.
x-ms-encryption-key-sha256

string

Server vrátí algoritmus SHA256 šifrovacího klíče poskytnutého zákazníkem, aby ověřil klíč použitý v operaci.
x-ms-encryption-scope

string

Pokud požadavek používal obor šifrování, klient může zajistit úspěšné zašifrování obsahu požadavku pomocí oboru šifrování.
x-ms-server-encrypted: true/false

boolean

Hodnota této hlavičky je nastavena na true, pokud je obsah požadavku úspěšně zašifrován pomocí zadaného algoritmu.

PathList

Name Typ Description
paths

Path[]