Sdílet prostřednictvím

Path - List

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

Vypisovat 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 služby Azure Data Lake Storage.
filesystem
 path True

string

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

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

boolean

Pokud je pravda, 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 je zadaný adresář, bude seznam obsahovat pouze cesty, které sdílejí stejný kořenový adresář.
resource
 query True

FilesystemResourceType

Hodnota musí být "filesystem" 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 cest, které se mají vrátit, překročí tento limit, vrátí se v hlavičce odpovědi x-ms-continuation token pokračování. Pokud se v odpovědi vrátí token pro pokračování, musí být zadán v následném vyvolání operace seznamu, aby bylo možné pokračovat v 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 vyvolání zakódován.
directory
 query

string

Filtruje výsledky na cesty v zadaném adresáři. Pokud adresář neexistuje, dojde k chybě.
maxResults
 query

integer (int32)

minimum: 1

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

integer (int32)

minimum: 1

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

boolean

Volitelný. Platné pouze v případě, že je pro účet povolená hierarchická Namespace. Pokud je hodnota true, hodnoty identity uživatele vrácené v polích vlastníka a skupiny jednotlivých položek seznamu se transformují z ID objektů Azure Active Directory na hlavní názvy uživatelů. Pokud je hodnota false, vrátí se hodnoty jako ID objektů Azure Active Directory. Výchozí hodnota je false. Všimněte si, že ID objektů skupiny a aplikace 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

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

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

string

Určuje standard UTC (Coordinated Universal Time) pro požadavek. 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žívá 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, kódu a zprávy HTTP jsou uvedené níže:

  • 400 Chybný požadavek, ContentLengthMustBeZero, "Hlavička požadavku Content-Length musí být nula."
  • 400 Chybný požadavek, InvalidAuthenticationInfo, "Ověřovací informace nejsou zadány ve správném formátu. Zkontrolujte hodnotu autorizační hlavičky.
  • 400 Chybný požadavek, InvalidFlushPosition, "Nahraná data nejsou souvislá nebo hodnota parametru dotazu pozice není rovna 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 nerozpozná."
  • 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 pro jeden 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, "Zdrojový identifikátor URI je neplatný".
  • 400 Chybný požadavek, InvalidUri, "Identifikátor URI požadavku je neplatný".
  • 400 Chybný požadavek MissingRequiredHeader, hlavička HTTP povinná pro tento požadavek není zadána.
  • 400 Chybný požadavek, MissingRequiredQueryParameter, "Parametr dotazu, který je povinný pro tento požadavek, není zadán."
  • 400 – Chybný požadavek, MultipleConditionHeadersNotSupported, hlavičky více podmínek nejsou podporovány.
  • 400 Chybný požadavek OutOfRangeInput, "Jeden ze vstupů požadavku je mimo rozsah."
  • 400 Bad Request, OutOfRangeQueryParameterValue, "Jeden z parametrů dotazu zadaný v identifikátoru URI požadavku je mimo povolený rozsah."
  • 400 Chybný požadavek, nepodporovanýHeader, "Jedna z hlaviček zadaných v požadavku není podporována.".
  • 400 Chybný požadavek, NepodporovanýQueryParameter, "Jeden z parametrů dotazu zadaný v identifikátoru URI požadavku není podporován."
  • 400 Chybný požadavek, nepodporovanýRestVersion, "Zadaná verze rest není podporována."
  • 403 Zakázáno, AccountIsDisabled, "Zadaný účet je zakázán."
  • 403 Zakázáno, AuthorizationFailure, "Tento požadavek nemá oprávnění k provedení této operace."
  • 403 Zakázáno, InsufficientAccountPermissions, "Účet, ke kterým se přistupuje, nemá dostatečná oprávnění ke spuštění 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, "Cesta ke zdroji operace přejmenování neexistuje."
  • 405 Metoda Není povolena, NepodporovanáHttpVerb, "Prostředek nepodporuje zadaný příkaz HTTP."
  • 409 Konflikt, DestinationPathIsBeingDeleted, "Zadaná cílová cesta je označena k odstranění."
  • 409 Konflikt, DirectoryNotEmpty, "Rekurzivní hodnota parametru dotazu musí být true pro odstranění neprázdného adresáře."
  • 409 Konflikt, FilesystemAlreadyExists, "Zadaný systém souborů již existuje."
  • 409 Konflikt, FilesystemBeingDeleted, "Zadaný systém souborů je odstraněn."
  • 409 Konflikt, InvalidDestinationPath, "Zadaná cesta nebo prvek cesty existuje a jeho typ prostředku je pro tuto operaci neplatný." * 409 Konflikt, InvalidFlushOperation, "Prostředek byl vytvořen nebo změněn rozhraním API služby Blob Service a nelze jej zapsat do rozhraní API služby Data Lake Storage."
  • 409 Konflikt, InvalidRenameSourcePath, "Zdrojový adresář nemůže být stejný jako cílový adresář, ani nemůže být cílem podadresář zdrojového adresáře."
  • 409 Konflikt, InvalidSourceOrDestinationResourceType, "Typ zdrojového a cílového prostředku musí být identický"
  • 409 Konflikt, LeaseAlreadyPresent, "Je již k dispozici zapůjčení."
  • 409 Konflikt, LeaseIdMismatchWithLeaseOperation, "Zadané ID zapůjčení neodpovídá ID zapůjčení prostředku se zadanou operací zapůjčení."
  • 409 Konflikt, LeaseIsAlreadyBroken, "Zapůjčení již bylo přerušeno a nelze ho znovu zlomit."
  • 409 Konflikt, LeaseIsBreakingAndCannotBeAcquired, "ID zapůjčení odpovídá, ale zapůjčení je momentálně v nefunkčním stavu a nelze jej získat, dokud nebude přerušen."
  • 409 Konflikt, LeaseIsBreakingAndCannotBeChanged, "ID zapůjčení odpovídá, ale zapůjčení je momentálně v způsobujícím stavu a nelze ho změnit."
  • 409 Konflikt, LeaseIsBrokenAndCannotBeRenewed, "ID zapůjčení odpovídá, ale zapůjčení bylo přerušeno explicitně a nelze ho obnovit."
  • 409 Konflikt, LeaseNameMismatch, "Zadaný název zapůjčení neodpovídá existujícímu názvu zapůjčení."
  • 409 Konflikt, LeaseNotPresentWithLeaseOperation, "ID zapůjčení není k dispozici se zadanou operací zapůjčení."
  • 409 Konflikt, PathAlreadyExists, "Zadaná cesta již existuje."
  • 409 Konflikt, PathConflict, "Zadaná cesta nebo prvek cesty existuje a jeho typ prostředku je pro tuto operaci neplatný."
  • 409 Konflikt, SourcePathIsBeingDeleted, "Zadaná zdrojová cesta je označena k odstranění."
  • 409 Konflikt, ResourceTypeMismatch, "Typ prostředku zadaný v požadavku neodpovídá typu prostředku."
  • 412 Předběžná podmínka selhala, ConditionNotMet, "Podmínka zadaná pomocí podmíněných hlaviček HTTP není splněna."
  • 412 Předběžná podmínka se nezdařila, LeaseIdMismatch, "Zadané ID zapůjčení neodpovídá ID zapůjčení prostředku."
  • 412 Předběžná podmínka selhala, LeaseIdMissing, "V současné době je pro prostředek zapůjčení a v žádosti nebyla zadána žádná ID zapůjčení."
  • 412 Předběžná podmínka selhala, LeaseNotPresent, "V současné době není pro prostředek žádné zapůjčení.".
  • 412 Předběžná podmínka se nezdařila, ZapůjčeníLost, "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í satisfiable, InvalidRange, "Zadaný rozsah je neplatný pro aktuální velikost prostředku."
  • 500 Vnitřní chyba serveru, InternalError, "Server zjistil vnitřní chybu. Zkuste žádost zopakovat."
  • 500 Vnitřní chyba serveru OperationTimedOut, "Operaci nelze dokončit v povoleném čase."
  • 503 Service Unavailable, ServerBusy, "Egress is over the account limit" (Výchozí přenos je nad limitem účtu).
  • 503 Service Unavailable, ServerBusy, "Ingress is over the account limit."
  • 503 Service Unavailable, ServerBusy, "Operations per second is over the account limit."
  • 503 Service Unavailable, ServerBusy, "Server is currently unable to receive requests. 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

Objekt
Name Typ Description
error

Error

Objekt odpovědi na chybu služby.

Error

Objekt

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

Výčet

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

Hodnota Description
filesystem

Path

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

Pokud je nastavena hodnota vlastnosti kontextu šifrování, vrátí nastavenou hodnotu. Platné pouze v případě, že je pro účet povolená hierarchická Namespace.
x-ms-encryption-key-sha256

string

Server ozvěne SHA256 šifrovacího klíče poskytnutého zákazníkem a ověří klíč použitý v operaci.
x-ms-encryption-scope

string

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

boolean

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

PathList

Objekt
Name Typ Description
paths

Path[]