Udostępnij za pośrednictwem

Path - List

  • Odwołanie
Usługa:
Storage Services
Wersja interfejsu API:
2023-08-03

Lista ścieżek i ich właściwości w danym systemie plików.

GET https://{accountName}.{dnsSuffix}/{filesystem}?recursive={recursive}&resource=filesystem
Z parametrami opcjonalnymi: 
GET https://{accountName}.{dnsSuffix}/{filesystem}?directory={directory}&recursive={recursive}&continuation={continuation}&maxResults={maxResults}&upn={upn}&resource=filesystem&timeout={timeout}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
accountName
 path True

string

Nazwa konta usługi Azure Storage.
dnsSuffix
 path True

string

Sufiks DNS dla punktu końcowego Azure Data Lake Storage.
filesystem
 path True

string

Identyfikator systemu plików. Wartość musi zaczynać się i kończyć literą lub cyfrą i musi zawierać tylko litery, cyfry i znak kreski (-). Kolejne kreski nie są dozwolone. Wszystkie litery muszą mieć małe litery. Wartość musi zawierać od 3 do 63 znaków.

Wzorzec wyrażenia regularnego: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$
recursive
 query True

boolean

Jeśli wartość "true", zostaną wyświetlone wszystkie ścieżki; W przeciwnym razie są wyświetlane tylko ścieżki w katalogu głównym systemu plików. Jeśli określono "katalog", lista będzie zawierać tylko ścieżki, które współużytkują ten sam katalog główny.
resource
 query True

FilesystemResourceType

Wartość musi być "system plików" dla wszystkich operacji systemu plików.
continuation
 query

string

Liczba ścieżek zwracanych z każdym wywołaniem jest ograniczona. Jeśli liczba ścieżek do zwrócenia przekracza ten limit, token kontynuacji jest zwracany w nagłówku odpowiedzi x-ms-continuation. Gdy w odpowiedzi zostanie zwrócony token kontynuacji, należy go określić w kolejnym wywołaniu operacji listy, aby kontynuować wyświetlanie listy ścieżek. Należy pamiętać, że token kontynuacji zwrócony w nagłówku odpowiedzi x-ms-continuation musi być zakodowany w adresie URL przed użyciem w kolejnych wywołaniach.
directory
 query

string

Filtruje wyniki do ścieżek w określonym katalogu. Błąd występuje, jeśli katalog nie istnieje.
maxResults
 query

integer

int32

Opcjonalna wartość określająca maksymalną liczbę elementów do zwrócenia. W przypadku pominięcia lub większego niż 5000 odpowiedź będzie zawierać maksymalnie 5000 elementów.
timeout
 query

integer

int32

Opcjonalna wartość limitu czasu operacji w sekundach. Okres rozpoczyna się po odebraniu żądania przez usługę. Jeśli wartość limitu czasu upłynie przed zakończeniem operacji, operacja zakończy się niepowodzeniem.
upn
 query

boolean

Opcjonalny. Prawidłowe tylko wtedy, gdy hierarchiczna przestrzeń nazw jest włączona dla konta. Jeśli wartość "true", wartości tożsamości użytkownika zwrócone w polach właściciela i grupy każdego wpisu listy zostaną przekształcone z identyfikatorów obiektów usługi Azure Active Directory na główne nazwy użytkowników. Jeśli wartość "false", wartości zostaną zwrócone jako identyfikatory obiektów usługi Azure Active Directory. Wartość domyślna to false. Należy pamiętać, że identyfikatory obiektów grup i aplikacji nie są tłumaczone, ponieważ nie mają unikatowych przyjaznych nazw.

Nagłówek żądania

Nazwa Wymagane Typ Opis
x-ms-client-request-id

string

Identyfikator UUID zarejestrowany w dziennikach analizy na potrzeby rozwiązywania problemów i korelacji.

Wzorzec wyrażenia regularnego: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
x-ms-date

string

Określa dla żądania godzinę w formacie uniwersalnego czasu koordynowanego (UTC). Jest to wymagane w przypadku korzystania z autoryzacji klucza współużytkowanego.
x-ms-version

string

Określa wersję protokołu REST używanego do przetwarzania żądania. Jest to wymagane w przypadku korzystania z autoryzacji klucza współużytkowanego.

Odpowiedzi

Nazwa Typ Opis
200 OK

PathList

Ok

Nagłówki

  • 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

Wystąpił błąd. Poniżej wymieniono możliwe stany HTTP, kod i ciągi komunikatów:

  • 400 Nieprawidłowe żądanie, ContentLengthMustBeZero, "Nagłówek żądania o długości zawartości musi mieć wartość zero".
  • 400 Nieprawidłowe żądanie, InvalidAuthenticationInfo, "Informacje o uwierzytelnianiu nie są podane w poprawnym formacie. Sprawdź wartość nagłówka autoryzacji".
  • 400 Nieprawidłowe żądanie, InvalidFlushPosition, "Przekazane dane nie są ciągłe lub wartość parametru zapytania pozycji nie jest równa długości pliku po dołączeniu przekazanych danych".
  • 400 Nieprawidłowe żądanie, InvalidHeaderValue, "Wartość jednego z nagłówków HTTP nie jest w poprawnym formacie".
  • 400 Nieprawidłowe żądanie, InvalidHttpVerb, "Określony czasownik HTTP jest nieprawidłowy — nie jest rozpoznawany przez serwer".
  • 400 Nieprawidłowe żądanie, InvalidInput, "Jeden z danych wejściowych żądania jest nieprawidłowy".
  • 400 Nieprawidłowe żądanie, InvalidPropertyName, "Nazwa właściwości nie może być pusta".
  • 400 Nieprawidłowe żądanie, InvalidPropertyName, "Nazwa właściwości zawiera nieprawidłowe znaki".
  • 400 Nieprawidłowe żądanie, InvalidQueryParameterValue, "Wartość jednego z parametrów zapytania określonych w identyfikatorze URI żądania jest nieprawidłowa".
  • 400 Nieprawidłowe żądanie, InvalidResourceName, "Określona nazwa zasobu zawiera nieprawidłowe znaki".
  • 400 Nieprawidłowe żądanie, InvalidSourceUri, "Źródłowy identyfikator URI jest nieprawidłowy".
  • 400 Nieprawidłowe żądanie, InvalidUri, "Identyfikator URI żądania jest nieprawidłowy".
  • 400 Nieprawidłowe żądanie, MissingRequiredHeader, "Nie określono nagłówka HTTP, który jest obowiązkowy dla tego żądania".
  • 400 Nieprawidłowe żądanie, MissingRequiredQueryParameter, "Nie określono parametru zapytania, który jest obowiązkowy dla tego żądania".
  • 400 Nieprawidłowe żądanie, MultipleConditionHeadersNotSupported, "Wiele nagłówków warunku nie jest obsługiwanych".
  • 400 Nieprawidłowe żądanie, OutOfRangeInput, "Jeden z danych wejściowych żądania jest poza zakresem".
  • 400 Nieprawidłowe żądanie, OutOfRangeQueryParameterValue, "Jeden z parametrów zapytania określonych w identyfikatorze URI żądania jest poza dopuszczalnym zakresem".
  • 400 Nieprawidłowe żądanie, NieobsługiwaneHeader, "Jeden z nagłówków określonych w żądaniu nie jest obsługiwany".
  • 400 Nieprawidłowe żądanie, NieobsługiwaneQueryParameter, "Jeden z parametrów zapytania określonych w identyfikatorze URI żądania nie jest obsługiwany".
  • 400 Nieprawidłowe żądanie, NieobsługiwaneRestVersion, "Określona wersja REST jest nieobsługiwana".
  • 403 Zabronione, AccountIsDisabled, "Określone konto jest wyłączone".
  • 403 Zabronione, AuthorizationFailure, "To żądanie nie jest autoryzowane do wykonania tej operacji."
  • 403 Zabronione, InsufficientAccountPermissions: "Dostęp do konta nie ma wystarczających uprawnień do wykonania tej operacji".
  • 404 Nie znaleziono, FilesystemNotFound, "Określony system plików nie istnieje."
  • 404 Nie znaleziono, PathNotFound, "Określona ścieżka nie istnieje".
  • 404 Nie znaleziono, RenameDestinationParentPathNotFound, "Katalog nadrzędny ścieżki docelowej nie istnieje."
  • 404 Nie znaleziono, ResourceNotFound, "Określony zasób nie istnieje".
  • 404 Nie znaleziono, SourcePathNotFound, "Ścieżka źródłowa operacji zmiany nazwy nie istnieje".
  • Metoda 405 Niedozwolona, NieobsługiwanaHttpVerb, "Zasób nie obsługuje określonego zlecenia HTTP".
  • 409 Conflict, DestinationPathIsBeingDeleted, "Określona ścieżka docelowa jest oznaczona do usunięcia."
  • 409 Conflict, DirectoryNotEmpty, "Wartość parametru zapytania cyklicznego musi być prawdziwa, aby usunąć niepusty katalog".
  • 409 Konflikt, System plikówAlreadyExists, "Określony system plików już istnieje."
  • 409 Konflikt, System plikówBeingDeleted: "Określony system plików jest usuwany".
  • 409 Conflict, InvalidDestinationPath, "Określona ścieżka lub element ścieżki, istnieje, a jego typ zasobu jest nieprawidłowy dla tej operacji." * 409 Konflikt, InvalidFlushOperation, "Zasób został utworzony lub zmodyfikowany przez interfejs API usługi Blob Service i nie może być zapisany przez interfejs API usługi Data Lake Storage."
  • 409 Conflict, InvalidRenameSourcePath, "Katalog źródłowy nie może być taki sam jak katalog docelowy, ani nie może być podkatalogem katalogu źródłowego."
  • Konflikt 409, InvalidSourceOrDestinationResourceType, "Typ zasobu źródłowego i docelowego musi być identyczny".
  • 409 Konflikt, LeaseAlreadyPresent, "Istnieje już dzierżawa".
  • 409 Conflict, LeaseIdMismatchWithLeaseOperation, "Określony identyfikator dzierżawy nie pasuje do identyfikatora dzierżawy zasobu z określoną operacją dzierżawy."
  • 409 Konflikt, LeaseIsAlreadyBroken: "Dzierżawa została już przerwana i nie można jej ponownie złamać".
  • 409 Konflikt, LeaseIsBreakingAndCannotBeAcquired: "Identyfikator dzierżawy został dopasowany, ale dzierżawa jest obecnie w stanie przerwania i nie można jej uzyskać, dopóki nie zostanie przerwana".
  • 409 Konflikt, LeaseIsBreakingAndCannotBeChanged: "Identyfikator dzierżawy został dopasowany, ale dzierżawa jest obecnie w stanie przerwania i nie można jej zmienić".
  • 409 Konflikt, LeaseIsBrokenAndCannotBeRenewed, "Identyfikator dzierżawy został dopasowany, ale dzierżawa została przerwana jawnie i nie można jej odnowić".
  • 409 Conflict, LeaseNameMismatch, "Określona nazwa dzierżawy nie jest zgodna z istniejącą nazwą dzierżawy".
  • 409 Conflict, LeaseNotPresentWithLeaseOperation, "Identyfikator dzierżawy nie jest obecny w określonej operacji dzierżawy."
  • 409 Konflikt, PathAlreadyExists, "Określona ścieżka już istnieje".
  • 409 Conflict, PathConflict, "Określona ścieżka lub element ścieżki, istnieje, a jego typ zasobu jest nieprawidłowy dla tej operacji".
  • 409 Conflict, SourcePathIsBeingDeleted, "Określona ścieżka źródłowa jest oznaczona do usunięcia.
  • 409 Conflict, ResourceTypeMismatch, "Typ zasobu określony w żądaniu nie jest zgodny z typem zasobu."
  • 412 Warunek wstępny niepowodzenie, ConditionNotMet, "Warunek określony przy użyciu nagłówków warunkowych HTTP nie jest spełniony."
  • 412 Niepowodzenie warunku wstępnego, LeaseIdMismatch, "Określony identyfikator dzierżawy nie pasuje do identyfikatora dzierżawy zasobu."
  • 412 Warunek wstępny nie powiodło się, LeaseIdMissing: "Obecnie istnieje dzierżawa zasobu i nie określono identyfikatora dzierżawy w żądaniu."
  • 412 Niepowodzenie warunku wstępnego, LeaseNotPresent, "Obecnie nie ma dzierżawy zasobu."
  • 412 Warunek wstępny Nie powiodło się, LeaseLost, "Określono identyfikator dzierżawy, ale dzierżawa zasobu wygasła".
  • 412 Niepowodzenie warunku wstępnego, SourceConditionNotMet, "Warunek źródłowy określony przy użyciu nagłówków warunkowych HTTP nie jest spełniony."
  • 413 Request Entity Too Large (Zbyt duża jednostka żądania, RequestBodyTooLarge), "Treść żądania jest zbyt duża i przekracza maksymalny dopuszczalny limit".
  • 416 Żądany zakres nie jest satysfiable, InvalidRange, "Określony zakres jest nieprawidłowy dla bieżącego rozmiaru zasobu."
  • 500 Wewnętrzny błąd serwera, InternalError, "Serwer napotkał błąd wewnętrzny. Ponów próbę żądania".
  • 500 Wewnętrzny błąd serwera, OperationTimedOut, "Nie można ukończyć operacji w dozwolonym czasie."
  • 503 Usługa niedostępna, ServerBusy, "Ruch wychodzący przekracza limit konta".
  • 503 Usługa niedostępna, ServerBusy, "Ruch przychodzący przekracza limit konta".
  • 503 Usługa niedostępna, ServerBusy, "Operacje na sekundę przekracza limit konta".
  • 503 Usługa niedostępna, ServerBusy, "Serwer nie może obecnie odbierać żądań. Ponów próbę żądania".

Nagłówki

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

Definicje

Nazwa Opis
DataLakeStorageError
Error

Obiekt odpowiedzi na błąd usługi.
FilesystemResourceType

Wartość musi być "system plików" dla wszystkich operacji systemu plików.
Path
PathList

DataLakeStorageError

Nazwa Typ Opis
error

Error

Obiekt odpowiedzi na błąd usługi.

Error

Obiekt odpowiedzi na błąd usługi.

Nazwa Typ Opis
code

string

Kod błędu usługi.
message

string

Komunikat o błędzie usługi.

FilesystemResourceType

Wartość musi być "system plików" dla wszystkich operacji systemu plików.

Nazwa Typ Opis
filesystem

string

Path

Nazwa Typ Domyślna wartość Opis
contentLength

integer

etag

string

group

string

isDirectory

boolean

False
lastModified

string

name

string

owner

string

permissions

string

x-ms-encryption-context

string

Jeśli ustawiono wartość właściwości kontekstu szyfrowania, zostanie zwrócona ustawiona wartość. Prawidłowe tylko wtedy, gdy hierarchiczna przestrzeń nazw jest włączona dla konta.
x-ms-encryption-key-sha256

string

Serwer wykona echo SHA256 klucza szyfrowania dostarczonego przez klienta, aby zweryfikować klucz używany w operacji.
x-ms-encryption-scope

string

Jeśli żądanie używa zakresu szyfrowania, aby klient mógł upewnić się, że zawartość żądania została pomyślnie zaszyfrowana przy użyciu zakresu szyfrowania.
x-ms-server-encrypted: true/false

boolean

Wartość tego nagłówka jest ustawiona na wartość true, jeśli zawartość żądania została pomyślnie zaszyfrowana przy użyciu określonego algorytmu.

PathList

Nazwa Typ Opis
paths

Path[]