Path - List
Lista ścieżek i ich właściwości w danym systemie plików.
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}
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
account
|
path | True |
string |
Nazwa konta usługi Azure Storage. |
dns
|
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. Regex pattern: |
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 zostanie określony "katalog", lista będzie zawierać tylko ścieżki, które współużytkują ten sam katalog główny. |
resource
|
query | True |
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-kontynuacja. Gdy token kontynuacji jest zwracany w odpowiedzi, musi zostać określony w kolejnym wywołaniu operacji listy, aby kontynuować wyświetlanie listy ścieżek. |
|
directory
|
query |
string |
Filtruje wyniki do ścieżek w określonym katalogu. Błąd występuje, jeśli katalog nie istnieje. |
|
max
|
query |
integer int32 |
Opcjonalna wartość określająca maksymalną liczbę elementów do zwrócenia. Jeśli pominięto lub więcej niż 5000, odpowiedź będzie zawierać do 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" zostanie zwrócona jako identyfikatory obiektów usługi Azure Active Directory. Wartość domyślna to false. Należy pamiętać, że identyfikatory obiektów grupy 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. Regex pattern: |
|
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ółdzielonego. |
|
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ółdzielonego. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Ok Headers
|
|
Other Status Codes |
Wystąpił błąd. Poniżej wymieniono możliwy stan HTTP, kod i ciągi komunikatów:
Headers
|
Definicje
Nazwa | Opis |
---|---|
Data |
|
Error |
Obiekt odpowiedzi na błąd usługi. |
Filesystem |
Wartość musi być "system plików" dla wszystkich operacji systemu plików. |
Path | |
Path |
DataLakeStorageError
Nazwa | Typ | Opis |
---|---|---|
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 | Wartość domyślna | 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 wartość właściwości kontekstu szyfrowania zostanie ustawiona, zwróci ustawioną wartość. Prawidłowe tylko wtedy, gdy hierarchiczna przestrzeń nazw jest włączona dla konta. |
|
x-ms-encryption-key-sha256 |
string |
Serwer powtórzy algorytm SHA256 klucza szyfrowania dostarczonego przez klienta, aby zweryfikować klucz używany w operacji. |
|
x-ms-encryption-scope |
string |
Jeśli żądanie użyło zakresu szyfrowania, aby klient mógł upewnić się, że zawartość żądania zostanie 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[] |