Condividi tramite

Path - List

  • Riferimento
Servizio:
Storage Services
Versione API:
2023-08-03

Elencare i percorsi e le relative proprietà nel file system specificato.

GET https://{accountName}.{dnsSuffix}/{filesystem}?recursive={recursive}&resource=filesystem
Con parametri facoltativi: 
GET https://{accountName}.{dnsSuffix}/{filesystem}?directory={directory}&recursive={recursive}&continuation={continuation}&maxResults={maxResults}&upn={upn}&resource=filesystem&timeout={timeout}

Parametri dell'URI

Nome In Necessario Tipo Descrizione
accountName
 path True

string

Nome dell'account di archiviazione di Azure.
dnsSuffix
 path True

string

Suffisso DNS per l'endpoint Azure Data Lake Storage.
filesystem
 path True

string

Identificatore del file system. Il valore deve iniziare e terminare con una lettera o un numero e deve contenere solo lettere, numeri e carattere trattino (-). I trattini consecutivi non sono consentiti. Tutte le lettere devono essere minuscole. Il valore deve avere una lunghezza compresa tra 3 e 63 caratteri.

Criterio di espressione regolare: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$
recursive
 query True

boolean

Se "true", vengono elencati tutti i percorsi; in caso contrario, vengono elencati solo i percorsi nella radice del file system. Se si specifica "directory", l'elenco includerà solo i percorsi che condividono la stessa radice.
resource
 query True

FilesystemResourceType

Il valore deve essere "filesystem" per tutte le operazioni del file system.
continuation
 query

string

Il numero di percorsi restituiti con ogni chiamata è limitato. Se il numero di percorsi da restituire supera questo limite, viene restituito un token di continuazione nell'intestazione della risposta x-ms-continuation. Quando viene restituito un token di continuazione nella risposta, è necessario specificarlo in una chiamata successiva dell'operazione di elenco per continuare a elencare i percorsi. Si noti che il token di continuazione restituito nell'intestazione della risposta x-ms-continuation deve essere codificato con URL prima di essere usato in una chiamata successiva.
directory
 query

string

Filtra i risultati per i percorsi all'interno della directory specificata. Se la directory non esiste, si verifica un errore.
maxResults
 query

integer

int32

Valore facoltativo che specifica il numero massimo di elementi da restituire. Se omesso o maggiore di 5.000, la risposta includerà fino a 5.000 elementi.
timeout
 query

integer

int32

Valore facoltativo del timeout dell'operazione in secondi. Il periodo inizia quando la richiesta viene ricevuta dal servizio. Se il valore di timeout è trascorso prima del completamento dell'operazione, l'operazione ha esito negativo.
upn
 query

boolean

facoltativo. Valido solo quando lo spazio dei nomi gerarchico è abilitato per l'account. Se "true", i valori di identità utente restituiti nei campi proprietario e gruppo di ogni voce di elenco verranno trasformati dagli ID oggetto di Azure Active Directory ai nomi delle entità utente. Se "false", i valori verranno restituiti come ID oggetto Azure Active Directory. Il valore predefinito è false. Si noti che gli ID oggetto gruppo e applicazione non vengono convertiti perché non hanno nomi descrittivi univoci.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
x-ms-client-request-id

string

UUID registrato nei log di analisi per la risoluzione dei problemi e la correlazione.

Criterio di espressione regolare: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
x-ms-date

string

Specifica la data per la richiesta nel fuso orario UTC (Coordinated Universal Time). Questa operazione è necessaria quando si usa l'autorizzazione della chiave condivisa.
x-ms-version

string

Specifica la versione del protocollo REST utilizzato per l'elaborazione della richiesta. Questa operazione è necessaria quando si usa l'autorizzazione della chiave condivisa.

Risposte

Nome Tipo Descrizione
200 OK

PathList

OK

Intestazioni

  • 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

Si è verificato un errore. Di seguito sono elencati i possibili stringhe di stato, codice e messaggio HTTP:

  • 400 Richiesta non valida, ContentLengthMustBeZero, "L'intestazione della richiesta Content-Length deve essere zero".
  • 400 Richiesta non valida, InvalidAuthenticationInfo, "Le informazioni di autenticazione non sono specificate nel formato corretto. Controllare il valore dell'intestazione Authorization."
  • 400 Richiesta non valida, InvalidFlushPosition, "I dati caricati non sono contigui o il valore del parametro della query di posizione non è uguale alla lunghezza del file dopo l'aggiunta dei dati caricati".
  • 400 Richiesta non valida, InvalidHeaderValue, "Il valore per una delle intestazioni HTTP non è nel formato corretto".
  • 400 Richiesta non valida, InvalidHttpVerb, "Il verbo HTTP specificato non è valido- non è riconosciuto dal server".
  • 400 Richiesta non valida, InvalidInput, "Uno degli input della richiesta non è valido".
  • 400 Richiesta non valida, InvalidPropertyName, "Un nome di proprietà non può essere vuoto".
  • 400 Richiesta non valida, InvalidPropertyName, "Il nome della proprietà contiene caratteri non validi".
  • 400 Richiesta non valida, InvalidQueryParameterValue, "Il valore per uno dei parametri di query specificati nell'URI della richiesta non è valido".
  • 400 Richiesta non valida, InvalidResourceName, "Il nome della risorsa specificato contiene caratteri non validi".
  • 400 Richiesta non valida, InvalidSourceUri, "L'URI di origine non è valido".
  • 400 Richiesta non valida, InvalidUri, "L'URI della richiesta non è valido".
  • 400 Richiesta non valida, MissingRequiredHeader, "Un'intestazione HTTP obbligatoria per questa richiesta non è specificata".
  • 400 Richiesta non valida, MissingRequiredQueryParameter, "Parametro di query obbligatorio per questa richiesta non specificato".
  • 400 Richiesta non valida, MultipleConditionHeadersNotSupported, "Le intestazioni di più condizioni non sono supportate".
  • 400 Richiesta non valida, OutOfRangeInput, "Uno degli input della richiesta non è compreso nell'intervallo".
  • 400 Richiesta non valida, OutOfRangeQueryParameterValue, "Uno dei parametri di query specificati nell'URI della richiesta non rientra nell'intervallo consentito".
  • 400 Richiesta non valida, UnsupportedHeader, "Una delle intestazioni specificate nella richiesta non è supportata".
  • 400 Richiesta non valida, Non supportatoQueryParameter, "Uno dei parametri di query specificati nell'URI della richiesta non è supportato".
  • 400 Richiesta non valida, Non supportatoRestVersion, "La versione rest specificata non è supportata".
  • 403 Accesso negato, AccountIsDisabled, "L'account specificato è disabilitato".
  • 403 Accesso negato, AuthorizationFailure, "Questa richiesta non è autorizzata a eseguire questa operazione".
  • 403 Accesso negato, InsufficientAccountPermissions, "L'account a cui si accede non dispone di autorizzazioni sufficienti per eseguire questa operazione".
  • 404 Non trovato, FilesystemNotFound, "Il file system specificato non esiste".
  • 404 Non trovato, PathNotFound, "Il percorso specificato non esiste".
  • 404 Non trovato, RenameDestinationParentPathNotFound, "La directory padre del percorso di destinazione non esiste".
  • 404 Non trovato, ResourceNotFound, "La risorsa specificata non esiste".
  • 404 Non trovato, SourcePathNotFound, "Il percorso di origine per un'operazione di ridenominazione non esiste".
  • 405 Metodo non consentito, Non supportatoHttpVerb, "La risorsa non supporta il verbo HTTP specificato".
  • 409 Conflitto, DestinationPathIsBeingDeleted, "Il percorso di destinazione specificato è contrassegnato per essere eliminato".
  • 409 Conflict, DirectoryNotEmpty, "The recursive query parameter value must be true to delete a non-empty directory."
  • 409 Conflict, FilesystemAlreadyExists, "The specified filesystem already exists".
  • 409 Conflict, FilesystemBeingDeleted, "The specified filesystem is being deleted."
  • 409 Conflict, InvalidDestinationPath, "The specified path, or an element of the path, exists and its resource type is invalid for this operation". * 409 Conflitto, InvalidFlushOperation, "La risorsa è stata creata o modificata dall'API del servizio BLOB e non può essere scritta dall'API del servizio Data Lake Storage".
  • 409 Conflict, InvalidRenameSourcePath, "The source directory cannot be the same as the destination directory, nor can the destination be a subdirectory of the source directory."
  • 409 Conflitto, InvalidSourceOrDestinationResourceType, "Il tipo di risorsa di origine e di destinazione deve essere identico".
  • 409 Conflict, LeaseAlreadyPresent, "There is already a lease present."
  • 409 Conflict, LeaseIdMismatchWithLeaseOperation, "L'ID lease specificato non corrisponde all'ID lease per la risorsa con l'operazione di lease specificata".
  • 409 Conflitto, LeaseIsAlreadyBroken, "Il lease è già stato interrotto e non può essere interrotto di nuovo".
  • 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, "The lease ID matched, but the lease is currently in breaking state and cannot be acquired until it broken".
  • 409 Conflict, LeaseIsBreakingAndCannotBeChanged, "The lease ID matched, but the lease is attualmente in breaking state and cannot be changed."
  • 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, "The lease ID matched, but the lease has been broken explicitly and cannot be renewed".
  • 409 Conflict, LeaseNameMismatch, "Il nome del lease specificato non corrisponde al nome del lease esistente".
  • 409 Conflict, LeaseNotPresentWithLeaseOperation, "L'ID lease non è presente con l'operazione di lease specificata".
  • 409 Conflict, PathAlreadyExists, "The specified path already exists".
  • 409 Conflict, PathConflict, "The specified path, or an element of the path, exists and its resource type is invalid for this operation".
  • 409 Conflict, SourcePathIsBeingDeleted, "The specified source path is marked to be deleted".
  • 409 Conflict, ResourceTypeMismatch, "Il tipo di risorsa specificato nella richiesta non corrisponde al tipo di risorsa".
  • 412 Precondizione non riuscita, ConditionNotMet, "La condizione specificata con intestazioni condizionali HTTP non viene soddisfatta".
  • 412 Precondizione non riuscita, LeaseIdMismatch, "L'ID lease specificato non corrisponde all'ID lease per la risorsa".
  • 412 Precondizione non riuscita, LeaseIdMissing, "Attualmente è presente un lease per la risorsa e non è stato specificato alcun ID lease nella richiesta".
  • 412 Precondizione non riuscita, LeaseNotPresent, "Attualmente non è disponibile alcun lease per la risorsa".
  • 412 Precondizione non riuscita, LeaseLost, "È stato specificato un ID lease, ma il lease per la risorsa è scaduto".
  • 412 Precondizione non riuscita, SourceConditionNotMet, "La condizione di origine specificata tramite intestazioni condizionali HTTP non viene soddisfatta".
  • 413 Richiedi entità troppo grande, RequestBodyTooLarge, "Il corpo della richiesta è troppo grande e supera il limite massimo consentito".
  • 416 Intervallo richiesto non satisfiable, InvalidRange, "L'intervallo specificato non è valido per le dimensioni correnti della risorsa".
  • 500 Errore interno del server, InternalError, "Il server ha rilevato un errore interno. Ritentare la richiesta"
  • 500 Errore interno del server, OperationTimedOut, "Impossibile completare l'operazione entro il tempo consentito".
  • 503 Servizio non disponibile, ServerBusy, "Uscita superata il limite di account".
  • 503 Servizio non disponibile, ServerBusy, "Ingress is over the account limit".
  • 503 Servizio non disponibile, ServerBusy, "Le operazioni al secondo superano il limite di account".
  • 503 Servizio non disponibile, ServerBusy, "Il server non è attualmente in grado di ricevere le richieste. Riprovare la richiesta."

Intestazioni

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

Definizioni

Nome Descrizione
DataLakeStorageError
Error

Oggetto risposta di errore del servizio.
FilesystemResourceType

Il valore deve essere "filesystem" per tutte le operazioni del file system.
Path
PathList

DataLakeStorageError

Nome Tipo Descrizione
error

Error

Oggetto risposta di errore del servizio.

Error

Oggetto risposta di errore del servizio.

Nome Tipo Descrizione
code

string

Codice di errore del servizio.
message

string

Messaggio di errore del servizio.

FilesystemResourceType

Il valore deve essere "filesystem" per tutte le operazioni del file system.

Nome Tipo Descrizione
filesystem

string

Path

Nome Tipo Valore predefinito Descrizione
contentLength

integer

etag

string

group

string

isDirectory

boolean

False
lastModified

string

name

string

owner

string

permissions

string

x-ms-encryption-context

string

Se il valore della proprietà del contesto di crittografia è impostato, restituirà il valore impostato. Valido solo quando lo spazio dei nomi gerarchico è abilitato per l'account.
x-ms-encryption-key-sha256

string

Il server eseguirà l'eco di SHA256 della chiave di crittografia fornita dal cliente per convalidare la chiave usata nell'operazione.
x-ms-encryption-scope

string

Se la richiesta ha usato un ambito di crittografia, in modo che il client possa garantire che il contenuto della richiesta venga crittografato correttamente usando l'ambito di crittografia.
x-ms-server-encrypted: true/false

boolean

Il valore di questa intestazione è impostato su true se il contenuto della richiesta viene crittografato correttamente usando l'algoritmo specificato.

PathList

Nome Tipo Descrizione
paths

Path[]